com.fatwire.services
Interface AuthorizationService

All Superinterfaces:

Service

public interface AuthorizationService
extends Service

the Authorization Service provides methods for checking permissions on assets and asset operations.

Method Summary

PermissionBean<java.lang.Object>	canAccessSlot(AssetId slot, java.lang.String function) Checks whether logged in user has access to the slot User details and site id is obtained from ics scope
PermissionBean<VersioningAuthorizationBean>	canApprove(AssetId assetId) Checks whether logged in user has access to approve the asset for the logged-in site
PermissionBean<VersioningAuthorizationBean>	canCheckin(AssetId assetId) Checks whether logged-in user has access to checking the assets for the logged-in site
PermissionBean<VersioningAuthorizationBean>	canCheckout(AssetId assetId) Checks whether logged-in user has access to checkout the asset for the logged-in site
PermissionBean<java.lang.Object>	canCopy(AssetId assetId) Checks whether logged in user has access to copy the asset for the logged-in site
PermissionBean<DeleteAuthorizationBean>	canDelete(AssetId assetId) Checks whether logged-in user has access to delete the asset for the logged-in site
PermissionBean<VersioningAuthorizationBean>	canEdit(AssetId assetId) Checks whether user have access to edit the assets for the given site
PermissionBean<java.lang.Object>	canInspect(AssetId assetId) Checks whether logged-in user has access to inspect the asset for the logged-in site
PermissionBean<java.lang.Object>	canPlacePage() Checks whether logged in user has access to place pages for the logged-in site
PermissionBean<java.lang.Object>	canPlacePage(AssetId assetId) Checks whether logged in user has access to place the page asset for the logged-in site
PermissionBean<java.lang.Object>	canPreview() Checks whether logged-in user has access to preview assets for the logged-in site
PermissionBean<java.lang.Object>	canPreview(AssetId assetId) Checks whether logged-in user has access to preview the assets for the logged-in site
PermissionBean<java.lang.Object>	canRollback(AssetId assetId) Checks whether logged-in user has access to roll back the asset for the logged-in site
PermissionBean<VersioningAuthorizationBean>	canShare(AssetId assetId) Checks whether logged-in user has access to share the assets for the logged-in site
PermissionBean<java.lang.Object>	canShowVersion(AssetId assetId) Checks whether logged-in user has access to delete the asset for the logged-in site
PermissionBean<VersioningAuthorizationBean>	canUndoCheckout(AssetId assetId) Checks whether logged-in user has access to undo checkout the asset for the logged-in site
PermissionBean<java.lang.Object>	hasAccess(AssetId assetId, java.lang.String function) Checks whether logged in user can perform the given function the asset for the logged in site
PermissionBean<java.lang.Object>	hasAccess(java.lang.String username, long pubId, AssetId assetId, java.lang.String function) Checks whether user can perform the given function the asset for the given site

Methods inherited from interface com.fatwire.services.Service

getManager, getResponse, setManager

Method Detail

canCopy

PermissionBean<java.lang.Object> canCopy(AssetId assetId)
                                         throws ServiceException

Checks whether logged in user has access to copy the asset for the logged-in site

Parameters:

assetId - id of the asset (i.e. AssetId)

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canApprove

PermissionBean<VersioningAuthorizationBean> canApprove(AssetId assetId)
                                                       throws ServiceException

Checks whether logged in user has access to approve the asset for the logged-in site

Parameters:

assetId - id of the asset (i.e. AssetId)

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canPlacePage

PermissionBean<java.lang.Object> canPlacePage(AssetId assetId)
                                              throws ServiceException

Checks whether logged in user has access to place the page asset for the logged-in site

Parameters:

assetId - id of the asset (i.e. AssetId)

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canPlacePage

PermissionBean<java.lang.Object> canPlacePage()
                                              throws ServiceException

Checks whether logged in user has access to place pages for the logged-in site

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canCheckin

PermissionBean<VersioningAuthorizationBean> canCheckin(AssetId assetId)
                                                       throws ServiceException

Checks whether logged-in user has access to checking the assets for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canCheckout

PermissionBean<VersioningAuthorizationBean> canCheckout(AssetId assetId)
                                                        throws ServiceException

Checks whether logged-in user has access to checkout the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canEdit

PermissionBean<VersioningAuthorizationBean> canEdit(AssetId assetId)
                                                    throws ServiceException

Checks whether user have access to edit the assets for the given site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canPreview

PermissionBean<java.lang.Object> canPreview(AssetId assetId)
                                            throws ServiceException

Checks whether logged-in user has access to preview the assets for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canPreview

PermissionBean<java.lang.Object> canPreview()
                                            throws ServiceException

Checks whether logged-in user has access to preview assets for the logged-in site

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canInspect

PermissionBean<java.lang.Object> canInspect(AssetId assetId)
                                            throws ServiceException

Checks whether logged-in user has access to inspect the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canRollback

PermissionBean<java.lang.Object> canRollback(AssetId assetId)
                                             throws ServiceException

Checks whether logged-in user has access to roll back the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canShare

PermissionBean<VersioningAuthorizationBean> canShare(AssetId assetId)
                                                     throws ServiceException

Checks whether logged-in user has access to share the assets for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canUndoCheckout

PermissionBean<VersioningAuthorizationBean> canUndoCheckout(AssetId assetId)
                                                            throws ServiceException

Checks whether logged-in user has access to undo checkout the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canShowVersion

PermissionBean<java.lang.Object> canShowVersion(AssetId assetId)
                                                throws ServiceException

Checks whether logged-in user has access to delete the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canDelete

PermissionBean<DeleteAuthorizationBean> canDelete(AssetId assetId)
                                                  throws ServiceException

Checks whether logged-in user has access to delete the asset for the logged-in site

Parameters:

assetId - id of the asset

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

hasAccess

PermissionBean<java.lang.Object> hasAccess(java.lang.String username,
                                           long pubId,
                                           AssetId assetId,
                                           java.lang.String function)
                                           throws ServiceException

Checks whether user can perform the given function the asset for the given site

Parameters:

username - the user name

pubId - the site ID

assetId - id of the asset

function - a function name from Function

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

hasAccess

PermissionBean<java.lang.Object> hasAccess(AssetId assetId,
                                           java.lang.String function)
                                           throws ServiceException

Checks whether logged in user can perform the given function the asset for the logged in site

Parameters:

assetId - id of the asset

function - a function name from Function

Returns:

an PermissionBean object which has the details about the access permission

Throws:

ServiceException

canAccessSlot

PermissionBean<java.lang.Object> canAccessSlot(AssetId slot,
                                               java.lang.String function)
                                               throws ServiceException

Checks whether logged in user has access to the slot User details and site id is obtained from ics scope

Parameters:

slot - given slot

function - a function name from Function

Returns:

true is the user has access to the slot

Throws:

ServiceException