Skip navigation links

com.fatwire.services
Interface AuthorizationService

All Superinterfaces:

Service

public interface AuthorizationService

extends Service

The Authorization Service provides methods for checking permissions for performing operations on assets. The operations are provided by the Function enum.

Method Summary

PermissionBean<java.lang.Object>	canAccessSlot(AssetId slot, java.lang.String function) Checks whether logged in user has access to the specified slot asset in the logged in site.
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(AssetId assetId) Checks whether logged in user is able to place the page asset 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<java.lang.Object>	canTranslate(AssetId assetId) Checks whether logged-in user has access to translate 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

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

canPlacePage

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

Checks whether logged in user is able to place the page asset for the logged-in site

Parameters:

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

Returns:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

canTranslate

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

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

Parameters:

assetId - id of the asset

Returns:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

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

Returns:

a PermissionBean object which has the details about the access permission

Throws:

ServiceException - wraps any exception underlying the service call.

canAccessSlot

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

Checks whether logged in user has access to the specified slot asset in the logged in site.

Parameters:

slot - the slot asset to be accessed.

function - a function name

Returns:

true if the user has access to the slot

Throws:

ServiceException - wraps any exception underlying the service call. TODO: Move to proposed Insite Service

Skip navigation links