org.alfresco.mobile.android.api.services.impl.onpremise

Class OnPremiseSiteServiceImpl

java.lang.Object

org.alfresco.mobile.android.api.services.impl.AlfrescoService

org.alfresco.mobile.android.api.services.impl.AbstractSiteServiceImpl

org.alfresco.mobile.android.api.services.impl.onpremise.OnPremiseSiteServiceImpl

All Implemented Interfaces:

android.os.Parcelable, Service, SiteService

public class OnPremiseSiteServiceImpl
extends AbstractSiteServiceImpl

Sites are a key concept within Alfresco Share for managing documents, wiki pages, blog posts, discussions, and other collaborative content relating to teams, projects, communities of interest, and other types of collaborative sites.
There are various methods relating to the Sites service, including the ability to:

• List Sites (Favorites, all sites, user are member of)

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<OnPremiseSiteServiceImpl>	CREATOR

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AbstractSiteServiceImpl

DEFAULT_ROLE, extraPropertiesCache

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface org.alfresco.mobile.android.api.services.SiteService

SORT_PROPERTY_SHORTNAME, SORT_PROPERTY_TITLE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
OnPremiseSiteServiceImpl(android.os.Parcel o)
OnPremiseSiteServiceImpl(RepositorySession repositorySession) Default constructor for service.

Method Summary

Methods

Modifier and Type	Method and Description
Site	addFavoriteSite(Site site) Adds the given site to the current users list of favorite sites.
protected PagingResult<Site>	computeAllSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext)
protected PagingResult<Site>	computeFavoriteSites(ListingContext listingContext)
protected PagingResult<Site>	computeSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext)
List<Person>	getAllMembers(Site site) Returns a list of site members.
PagingResult<Person>	getAllMembers(Site site, ListingContext listingContext) Returns a paged list of site members.
protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getAllSitesUrl(ListingContext listingContext) Allows to retrieve URL to list all sites.
protected String	getCancelJoinSiteRequestUrl(JoinSiteRequestImpl joinSiteRequest) Allow to retrieve specific cancel join site url.
protected String	getDocContainerSiteUrl(Site site) Allow to retrieve specific site document container URL.
List<Site>	getFavoriteSites()
protected List<JoinSiteRequestImpl>	getJoinSiteRequests()
protected PagingResult<JoinSiteRequestImpl>	getJoinSiteRequests(ListingContext listingContext)
protected String	getLeaveSiteUrl(Site site) Retrieve specific leave site url.
protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getSiteUrl(String siteIdentifier) Allows to retrieve specific site url.
protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getUserSitesUrl(String personIdentifier, ListingContext listingContext) Allows to retrieve URL to list sites for a specific user.
boolean	isMember(Site site, Person person) Returns true if the person is a member of the specified site.
Site	joinSite(Site site) Adds the current user as a member of the given site with an optional message explaining why they wish to join the site.
protected String	parseContainer(String link)
protected Site	parseData(String siteIdentifier, Map<String,Object> json) Responsible to create a Site object based on json response from the server.
Site	removeFavoriteSite(Site site) Removes the given site from the current users list of favorite sites.
protected void	retrieveExtraProperties(String personIdentifier) Retrieve sites extra properties.
List<Person>	searchMembers(Site site, String keywords)
PagingResult<Person>	searchMembers(Site site, String keywords, ListingContext listingContext)

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AbstractSiteServiceImpl

cancelJoinSiteRequest, cancelRequestToJoinSite, clear, computeLegacySites, getAllSites, getAllSites, getDocumentLibrary, getFavoriteSites, getPendingSites, getPendingSites, getSite, getSites, getSites, leaveSite, refresh, retrieveExtraProperties, search, search, updateExtraPropertyCache, validateUpdateSite

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

convertException, convertNode, convertNode, convertStatusCode, delete, describeContents, getHttpInvoker, getSessionHttp, isCloudSession, isListNull, isMapNull, isObjectNull, isOnPremiseSession, isStringNull, post, put, read, saveContentStream, writeToParcel

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<OnPremiseSiteServiceImpl> CREATOR

Constructor Detail

OnPremiseSiteServiceImpl

public OnPremiseSiteServiceImpl(RepositorySession repositorySession)

Default constructor for service.
Used by the AbstractServiceRegistry.

Parameters:

repositorySession -

OnPremiseSiteServiceImpl

public OnPremiseSiteServiceImpl(android.os.Parcel o)

Method Detail

getAllSitesUrl

protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder getAllSitesUrl(ListingContext listingContext)

Allows to retrieve URL to list all sites.

Specified by:

getAllSitesUrl in class AbstractSiteServiceImpl

Parameters:

listingContext - : determine characteristics of the result (paging)

Returns:

UrlBuilder based on all sites link.

getUserSitesUrl

protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder getUserSitesUrl(String personIdentifier,
                                                                    ListingContext listingContext)

Allows to retrieve URL to list sites for a specific user.

Specified by:

getUserSitesUrl in class AbstractSiteServiceImpl

Parameters:

personIdentifier - : unique identifier of the user

listingContext - : determine characteristics of the result (paging)

Returns:

UrlBuilder based on link.

getFavoriteSites

public List<Site> getFavoriteSites()

Specified by:

getFavoriteSites in interface SiteService

Overrides:

getFavoriteSites in class AbstractSiteServiceImpl

Returns:

Returns a list of sites the current user has a explicit membership to and has marked as a favourite.

computeFavoriteSites

protected PagingResult<Site> computeFavoriteSites(ListingContext listingContext)

Specified by:

computeFavoriteSites in class AbstractSiteServiceImpl

getSiteUrl

protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder getSiteUrl(String siteIdentifier)

Allows to retrieve specific site url.

Specified by:

getSiteUrl in class AbstractSiteServiceImpl

Parameters:

siteIdentifier - : Unique identifier of the site.

Returns:

URl to retrieve information about site.

parseData

protected Site parseData(String siteIdentifier,
             Map<String,Object> json)

Responsible to create a Site object based on json response from the server.

Specified by:

parseData in class AbstractSiteServiceImpl

json - : response from the server.

Returns:

Site object

getDocContainerSiteUrl

protected String getDocContainerSiteUrl(Site site)

Allow to retrieve specific site document container URL.

Specified by:

getDocContainerSiteUrl in class AbstractSiteServiceImpl

Parameters:

site - : Site

Returns:

URl to retrieve information about site document container.

addFavoriteSite

public Site addFavoriteSite(Site site)

Adds the given site to the current users list of favorite sites.
It's possible to favorite a site independently of its visibility.

Parameters:

site - : site object

removeFavoriteSite

public Site removeFavoriteSite(Site site)

Removes the given site from the current users list of favorite sites.
It's possible to favorite a site independently of its visibility.

Parameters:

site - : site object

isMember

public boolean isMember(Site site,
               Person person)

Description copied from interface: SiteService

Returns true if the person is a member of the specified site.

Returns:

joinSite

public Site joinSite(Site site)

Adds the current user as a member of the given site with an optional message explaining why they wish to join the site.

Parameters:

site - : site object

Returns:

If the site is moderated, a JoinSiteRequest object is returned.
If the site is public null is returned.

getJoinSiteRequests

protected List<JoinSiteRequestImpl> getJoinSiteRequests()

Specified by:

getJoinSiteRequests in class AbstractSiteServiceImpl

getJoinSiteRequests

protected PagingResult<JoinSiteRequestImpl> getJoinSiteRequests(ListingContext listingContext)

Specified by:

getJoinSiteRequests in class AbstractSiteServiceImpl

getCancelJoinSiteRequestUrl

protected String getCancelJoinSiteRequestUrl(JoinSiteRequestImpl joinSiteRequest)

Allow to retrieve specific cancel join site url.

Specified by:

getCancelJoinSiteRequestUrl in class AbstractSiteServiceImpl

Returns:

URl to cancel a join request.

getLeaveSiteUrl

protected String getLeaveSiteUrl(Site site)

Retrieve specific leave site url.

Specified by:

getLeaveSiteUrl in class AbstractSiteServiceImpl

Parameters:

site - : Site

Returns:

URl to leave a site.

getAllMembers

public List<Person> getAllMembers(Site site)

Returns a list of site members.

Returns:

getAllMembers

public PagingResult<Person> getAllMembers(Site site,
                                 ListingContext listingContext)

Returns a paged list of site members.

Returns:

searchMembers

public List<Person> searchMembers(Site site,
                         String keywords)

Returns:

searchMembers

public PagingResult<Person> searchMembers(Site site,
                                 String keywords,
                                 ListingContext listingContext)

Returns:

computeSites

protected PagingResult<Site> computeSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                              ListingContext listingContext)

Specified by:

computeSites in class AbstractSiteServiceImpl

parseContainer

protected String parseContainer(String link)

Specified by:

parseContainer in class AbstractSiteServiceImpl

computeAllSites

protected PagingResult<Site> computeAllSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                                 ListingContext listingContext)

Specified by:

computeAllSites in class AbstractSiteServiceImpl

retrieveExtraProperties

protected void retrieveExtraProperties(String personIdentifier)

Description copied from class: AbstractSiteServiceImpl

Retrieve sites extra properties.

Specified by:

retrieveExtraProperties in class AbstractSiteServiceImpl