org.alfresco.test.utils.api

Class PublicApiUtils

java.lang.Object

org.alfresco.test.utils.api.PublicApiUtils

public class PublicApiUtils
extends Object

Class to contain Public api client Utils

Since:

1.0

Author:

Meenal Bhave

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.rest.api.tests.client.PublicApiClient.Comments	commentsClient
protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.DeploymentsClient	deploymentsClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.Favourites	favouriteClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.Nodes	nodesClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.People	peopleClient
protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.ProcessesClient	processesClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.SiteMembershipRequests	siteMembershipRequestsClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.Sites	sitesClient
protected org.alfresco.rest.api.tests.client.PublicApiClient.Tags	tagsClient
protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.TasksClient	taskClient

Constructor Summary

Constructors

Constructor and Description
PublicApiUtils(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
org.alfresco.rest.api.tests.client.data.Favourite	createFavourite(String[] authUser, String forUser, String domain, String id, NodeType type) Create and POST a Favourite object for a Site.
org.alfresco.rest.api.tests.client.data.Favourite	createFavouriteForTarget(String[] authUser, String forUser, String domain, org.alfresco.rest.api.tests.client.data.FavouritesTarget target) Create and POST a Favourite object for a Site.
org.alfresco.rest.api.tests.client.data.Favourite	getFavouriteForId(String[] authUser, String domain, String guid) Gets the Favourite object for a particular guid.
org.alfresco.rest.api.tests.client.HttpResponse	getFavourites(String[] authUser, String forUser, String domain, Map<String,String> favMap) Gets a HttpResponse for GetFavourites Request for a particular person Id.
org.alfresco.rest.api.tests.client.PublicApiClient.ListResponse<org.alfresco.rest.api.tests.client.data.Favourite>	getFavouritesList(String[] authUser, String forUser, String domain, Map<String,String> favMap)
org.alfresco.rest.api.tests.client.HttpResponse	getMyFavourites(String[] authenticationDetails, String domain, Map<String,String> favMap) Gets a list Favourite object for a particular person Id.
org.alfresco.rest.api.tests.client.PublicApiClient	getPublicApiClient()
protected void	initClients()
org.alfresco.rest.api.tests.client.data.Favourite	makeFileFavourite(String targetGuid)
org.alfresco.rest.api.tests.client.data.Favourite	makeFolderFavourite(String targetGuid)
org.alfresco.rest.api.tests.client.data.Favourite	makeSiteFavourite(org.alfresco.rest.api.tests.client.data.Site site)
org.alfresco.rest.api.tests.client.HttpResponse	removeFavouriteForGuid(String[] authUser, String forUser, String domain, String guid) Removed favourite for a guid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodesClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.Nodes nodesClient

peopleClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.People peopleClient

sitesClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.Sites sitesClient

siteMembershipRequestsClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.SiteMembershipRequests siteMembershipRequestsClient

favouriteClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.Favourites favouriteClient

tagsClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.Tags tagsClient

commentsClient

protected org.alfresco.rest.api.tests.client.PublicApiClient.Comments commentsClient

deploymentsClient

protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.DeploymentsClient deploymentsClient

taskClient

protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.TasksClient taskClient

processesClient

protected org.alfresco.rest.workflow.api.tests.WorkflowApiClient.ProcessesClient processesClient

Constructor Detail

PublicApiUtils

public PublicApiUtils(ApiClient apiClient)

Method Detail

initClients

protected void initClients()

getPublicApiClient

public org.alfresco.rest.api.tests.client.PublicApiClient getPublicApiClient()

getFavourites

public org.alfresco.rest.api.tests.client.HttpResponse getFavourites(String[] authUser,
                                                                     String forUser,
                                                                     String domain,
                                                                     Map<String,String> favMap)
                                                              throws org.alfresco.rest.api.tests.client.PublicApiException

Gets a HttpResponse for GetFavourites Request for a particular person Id.

Parameters:

authUser -

forUser -

domain -

favMap -

Returns:

ListResponse

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

getMyFavourites

public org.alfresco.rest.api.tests.client.HttpResponse getMyFavourites(String[] authenticationDetails,
                                                                       String domain,
                                                                       Map<String,String> favMap)
                                                                throws org.alfresco.rest.api.tests.client.PublicApiException

Gets a list Favourite object for a particular person Id.

Parameters:

authenticationDetails -

domain -

favMap -

Returns:

ListResponse

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

getFavouritesList

public org.alfresco.rest.api.tests.client.PublicApiClient.ListResponse<org.alfresco.rest.api.tests.client.data.Favourite> getFavouritesList(String[] authUser,
                                                                                                                                            String forUser,
                                                                                                                                            String domain,
                                                                                                                                            Map<String,String> favMap)
                                                                                                                                     throws org.alfresco.rest.api.tests.client.PublicApiException,
                                                                                                                                            ParseException

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

ParseException

getFavouriteForId

public org.alfresco.rest.api.tests.client.data.Favourite getFavouriteForId(String[] authUser,
                                                                           String domain,
                                                                           String guid)
                                                                    throws org.alfresco.rest.api.tests.client.PublicApiException,
                                                                           ParseException

Gets the Favourite object for a particular guid.

Parameters:

authUser - String

domain - String

guid - String target guid

Returns:

Favourite

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

ParseException

createFavourite

public org.alfresco.rest.api.tests.client.data.Favourite createFavourite(String[] authUser,
                                                                         String forUser,
                                                                         String domain,
                                                                         String id,
                                                                         NodeType type)
                                                                  throws org.alfresco.rest.api.tests.client.PublicApiException,
                                                                         ParseException

Create and POST a Favourite object for a Site.

Parameters:

authUser -

domain -

id - - The guid in case of folder, file. Site id in case of site.

type -

Returns:

Favourite

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

ParseException

createFavouriteForTarget

public org.alfresco.rest.api.tests.client.data.Favourite createFavouriteForTarget(String[] authUser,
                                                                                  String forUser,
                                                                                  String domain,
                                                                                  org.alfresco.rest.api.tests.client.data.FavouritesTarget target)
                                                                           throws org.alfresco.rest.api.tests.client.PublicApiException,
                                                                                  ParseException

Create and POST a Favourite object for a Site.

Parameters:

authUser -

domain -

forUser -

target -

Returns:

Favourite

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

ParseException

removeFavouriteForGuid

public org.alfresco.rest.api.tests.client.HttpResponse removeFavouriteForGuid(String[] authUser,
                                                                              String forUser,
                                                                              String domain,
                                                                              String guid)
                                                                       throws org.alfresco.rest.api.tests.client.PublicApiException

Removed favourite for a guid.

Parameters:

authUser -

forUser -

domain -

guid -

Returns:

HttpResponse

Throws:

org.alfresco.rest.api.tests.client.PublicApiException

makeSiteFavourite

public org.alfresco.rest.api.tests.client.data.Favourite makeSiteFavourite(org.alfresco.rest.api.tests.client.data.Site site)
                                                                    throws ParseException

Throws:

ParseException

makeFolderFavourite

public org.alfresco.rest.api.tests.client.data.Favourite makeFolderFavourite(String targetGuid)
                                                                      throws ParseException

Throws:

ParseException

makeFileFavourite

public org.alfresco.rest.api.tests.client.data.Favourite makeFileFavourite(String targetGuid)
                                                                    throws ParseException

Throws:

ParseException