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

Class AbstractSiteServiceImpl

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, Service, SiteService

Direct Known Subclasses:

OnPremiseSiteServiceImpl, PublicAPISiteServiceImpl

public abstract class AbstractSiteServiceImpl
extends AlfrescoService
implements SiteService

Abstract class implementation of SiteService. Responsible of sharing common methods between child class (OnPremise and Cloud)

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
protected static String	DEFAULT_ROLE When user wants to join a site, the default role is SiteConsumer.
protected android.util.LruCache<String,CacheSiteExtraProperties>	extraPropertiesCache extraPropertiesCache is a LRUCache responsible to maintain extra informations about the site object.

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
AbstractSiteServiceImpl(AlfrescoSession repositorySession) Default constructor for service.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelJoinSiteRequest(JoinSiteRequestImpl joinSiteRequest)
Site	cancelRequestToJoinSite(Site site) Cancels a previous request to join a site made by the current user.
void	clear() Clear all caches informations used by the service.
protected abstract PagingResult<Site>	computeAllSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext)
protected abstract PagingResult<Site>	computeFavoriteSites(ListingContext listingContext)
protected PagingResult<Site>	computeLegacySites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext)
protected abstract PagingResult<Site>	computeSites(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext)
List<Site>	getAllSites()
PagingResult<Site>	getAllSites(ListingContext listingContext)
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getAllSitesUrl(ListingContext listingContext) Allows to retrieve URL to list all sites.
protected abstract String	getCancelJoinSiteRequestUrl(JoinSiteRequestImpl joinSiteRequest) Allow to retrieve specific cancel join site url.
protected abstract String	getDocContainerSiteUrl(Site site) Allow to retrieve specific site document container URL.
Folder	getDocumentLibrary(Site site) Get the documents container folder for the given site.
List<Site>	getFavoriteSites()
PagingResult<Site>	getFavoriteSites(ListingContext listingContext)
protected abstract List<JoinSiteRequestImpl>	getJoinSiteRequests()
protected abstract PagingResult<JoinSiteRequestImpl>	getJoinSiteRequests(ListingContext listingContext)
protected abstract String	getLeaveSiteUrl(Site site) Retrieve specific leave site url.
List<Site>	getPendingSites() Returns a list of join site requests from the current user that have yet to be actioned.
PagingResult<Site>	getPendingSites(ListingContext listingContext) Returns a list of join site requests from the current user that have yet to be actioned.
Site	getSite(String siteIdentifier)
List<Site>	getSites()
PagingResult<Site>	getSites(ListingContext listingContext)
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getSiteUrl(String siteIdentifier) Allows to retrieve specific site url.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getUserSitesUrl(String personIdentifier, ListingContext listingContext) Allows to retrieve URL to list sites for a specific user.
Site	leaveSite(Site site) Removes the current user from the given site.
protected abstract String	parseContainer(String link)
protected abstract Site	parseData(String siteIdentifier, Map<String,Object> json) Responsible to create a Site object based on json response from the server.
Site	refresh(Site site) Create a new site with the refreshed value from the cacheExtraProperties.
protected void	retrieveExtraProperties(List<String> favoriteSites, List<String> userSites, List<JoinSiteRequestImpl> request) Responsible to create the extra properties cache.
protected abstract void	retrieveExtraProperties(String personIdentifier) Retrieve sites extra properties.
List<Site>	search(String keyword)
PagingResult<Site>	search(String keyword, ListingContext listingContext)
protected void	updateExtraPropertyCache(String siteIdentifier, boolean isPendingMember, boolean isMember, boolean isFavorite) Update the defined entry cache.
protected void	validateUpdateSite(Site updatedSite, int errorCode)

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 org.alfresco.mobile.android.api.services.SiteService

addFavoriteSite, getAllMembers, getAllMembers, isMember, joinSite, removeFavoriteSite, searchMembers, searchMembers

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

DEFAULT_ROLE

protected static final String DEFAULT_ROLE

When user wants to join a site, the default role is SiteConsumer.

See Also:

Constant Field Values

extraPropertiesCache

protected android.util.LruCache<String,CacheSiteExtraProperties> extraPropertiesCache

extraPropertiesCache is a LRUCache responsible to maintain extra informations about the site object. Indeed it's not possible with one HTTP request to obtain all this informations at one time. For client’s convenience three new boolean flags to show whether the user is already a member, waiting to become a member and whether they have favorited the site will be added.

Since:

1.1.0

Constructor Detail

AbstractSiteServiceImpl

public AbstractSiteServiceImpl(AlfrescoSession repositorySession)

Default constructor for service.
Used by the AbstractServiceRegistry.

Parameters:

repositorySession -

Method Detail

getAllSites

public List<Site> getAllSites()

Specified by:

getAllSites in interface SiteService

Returns:

Return a list of all the sites in the repository the current user has visibility of.

getAllSitesUrl

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

Allows to retrieve URL to list all sites.

Parameters:

listingContext - : determine characteristics of the result (paging)

Returns:

UrlBuilder based on all sites link.

getAllSites

public PagingResult<Site> getAllSites(ListingContext listingContext)

Specified by:

getAllSites in interface SiteService

Parameters:

listingContext - : Listing context that define the behavior of paging results ListingContext

Returns:

Return a paged list of all the sites in the repository the current user has visibility of.

getSites

public List<Site> getSites()

Specified by:

getSites in interface SiteService

Returns:

Returns a list of sites the current user has a explicit membership to.

getUserSitesUrl

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

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

Parameters:

personIdentifier - : unique identifier of the user

listingContext - : determine characteristics of the result (paging)

Returns:

UrlBuilder based on link.

getSites

public PagingResult<Site> getSites(ListingContext listingContext)

Specified by:

getSites in interface SiteService

Parameters:

listingContext - : Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a paged list of sites the current user has a explicit membership to.

getFavoriteSites

public List<Site> getFavoriteSites()

Specified by:

getFavoriteSites in interface SiteService

Returns:

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

getFavoriteSites

public PagingResult<Site> getFavoriteSites(ListingContext listingContext)

Specified by:

getFavoriteSites in interface SiteService

Parameters:

listingContext - : Listing context that define the behaviour of paging results ListingContext

Returns:

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

search

public List<Site> search(String keyword)

Specified by:

search in interface SiteService

Returns:

Returns a list of sites which matches the current keywords.

search

public PagingResult<Site> search(String keyword,
                        ListingContext listingContext)

Specified by:

search in interface SiteService

Returns:

Returns a list of sites which matches the current keywords.

getSiteUrl

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

Allows to retrieve specific site url.

Parameters:

siteIdentifier - : Unique identifier of the site.

Returns:

URl to retrieve information about site.

parseData

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

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

Parameters:

siteIdentifier -

json - : response from the server.

Returns:

Site object

getSite

public Site getSite(String siteIdentifier)

Specified by:

getSite in interface SiteService

Parameters:

siteIdentifier - : Unique identifier name of the site.

Returns:

Returns a site with the given short name, if the site doesn’t exist null is returned.

getDocContainerSiteUrl

protected abstract String getDocContainerSiteUrl(Site site)

Allow to retrieve specific site document container URL.

Parameters:

site - : Site

Returns:

URl to retrieve information about site document container.

getDocumentLibrary

public Folder getDocumentLibrary(Site site)

Get the documents container folder for the given site.

Specified by:

getDocumentLibrary in interface SiteService

Parameters:

site - : Unique identifier name of the site.

Returns:

Returns the root folder container to share document library.

getCancelJoinSiteRequestUrl

protected abstract String getCancelJoinSiteRequestUrl(JoinSiteRequestImpl joinSiteRequest)

Allow to retrieve specific cancel join site url.

Returns:

URl to cancel a join request.

cancelJoinSiteRequest

public void cancelJoinSiteRequest(JoinSiteRequestImpl joinSiteRequest)

cancelRequestToJoinSite

public Site cancelRequestToJoinSite(Site site)

Description copied from interface: SiteService

Cancels a previous request to join a site made by the current user.

Specified by:

cancelRequestToJoinSite in interface SiteService

Parameters:

site - : site object

getLeaveSiteUrl

protected abstract String getLeaveSiteUrl(Site site)

Retrieve specific leave site url.

Parameters:

site - : Site

Returns:

URl to leave a site.

leaveSite

public Site leaveSite(Site site)

Removes the current user from the given site.

Specified by:

leaveSite in interface SiteService

Parameters:

site - : site object

getJoinSiteRequests

protected abstract List<JoinSiteRequestImpl> getJoinSiteRequests()

getJoinSiteRequests

protected abstract PagingResult<JoinSiteRequestImpl> getJoinSiteRequests(ListingContext listingContext)

getPendingSites

public List<Site> getPendingSites()

Returns a list of join site requests from the current user that have yet to be actioned. An empty list is returned if there are no outstanding requests.

Specified by:

getPendingSites in interface SiteService

Returns:

: List of site the user wants to join. Empty list if there's no request.

getPendingSites

public PagingResult<Site> getPendingSites(ListingContext listingContext)

Returns a list of join site requests from the current user that have yet to be actioned. An empty list is returned if there are no outstanding requests.

Specified by:

getPendingSites in interface SiteService

Returns:

Returns a paged list of sites the current user has requested to be a member.

validateUpdateSite

protected void validateUpdateSite(Site updatedSite,
                      int errorCode)

updateExtraPropertyCache

protected void updateExtraPropertyCache(String siteIdentifier,
                            boolean isPendingMember,
                            boolean isMember,
                            boolean isFavorite)

Update the defined entry cache.

Parameters:

siteIdentifier - : Unique identifier of the site

isPendingMember - : has a pending request to join the site

isMember - : member of the site

isFavorite - : member has favorite the site

Since:

1.1.0

clear

public void clear()

Clear all caches informations used by the service.

Specified by:

clear in interface Service

Overrides:

clear in class AlfrescoService

Since:

1.1.0

retrieveExtraProperties

protected abstract void retrieveExtraProperties(String personIdentifier)

Retrieve sites extra properties.

Parameters:

personIdentifier -

retrieveExtraProperties

protected void retrieveExtraProperties(List<String> favoriteSites,
                           List<String> userSites,
                           List<JoinSiteRequestImpl> request)

Responsible to create the extra properties cache.

Parameters:

favoriteSites - : List of user favorite site Identifier.

userSites - : List of user site Identifier.

request - : List of user request.

refresh

public Site refresh(Site site)

Create a new site with the refreshed value from the cacheExtraProperties.

Parameters:

site - : old site to refresh.

Returns:

Newly created and updated site.

computeFavoriteSites

protected abstract PagingResult<Site> computeFavoriteSites(ListingContext listingContext)

computeSites

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

computeAllSites

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

parseContainer

protected abstract String parseContainer(String link)

computeLegacySites

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