|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityPublicationService
This service class should be used to manage entity publications. It provides methods to ceate, update, delete entity-publications in the persistent store. Runtime authorization checks are based on these publications and authorization scopes of a logged-in user.
EntityPublication
, AdminRoleMembership
Method Summary | |
---|---|
java.util.List |
addEntityPublications(java.util.List entityPublications) Publish entity into given scopes. |
java.util.List |
addEntityPublications(java.util.List entityPublications, boolean publishDependentData) Publish entity into given scopes along with the dependent data. |
java.util.List |
listEntityPublicationInScope(PolicyConstants.Resources entityType, java.lang.String entityId, java.lang.String scopeId, boolean includeHierarchy, java.util.Map paramsMap) Returns a list of publications that publish given entity in a particular scope. |
java.util.List |
listEntityPublications(PolicyConstants.Resources entityType, java.lang.String entityId, java.util.Map paramsMap) Collates and returns a list of scopes in which an entity is published. |
java.util.List |
listEntityPublicationsInScope(PolicyConstants.Resources entityType, java.lang.String scopeId, java.util.Map paramsMap) List all the publications of an entity type in given scope |
boolean |
removeEntityPublications(java.util.List entityPublications) Remove entity publications from the scopes. |
boolean |
removeEntityPublications(java.util.List entityPublications, boolean unpublishDependentData) Removes the already published entities. |
java.util.List |
search(EntityPublicationSearchCriteria criteria, java.util.Map paramsMap) Searches for publications matching the specified SearchCriteria . |
boolean |
updateEntityPublications(java.util.List updatedEntityPublications) Update entity publications. |
Method Detail |
---|
java.util.List addEntityPublications(java.util.List entityPublications)
entityPublications
- a list of entity publications with valid entity reference and scope reference.boolean removeEntityPublications(java.util.List entityPublications)
entityPublications
- a list of entity publications to be removed.boolean updateEntityPublications(java.util.List updatedEntityPublications)
updatedEntityPublications
- a list of entity publications to be updated.java.util.List listEntityPublications(PolicyConstants.Resources entityType, java.lang.String entityId, java.util.Map paramsMap)
entityType
- valid entity type, required. Currently supported are: - PolicyConstants.Resources.ROLE - for Role publishing. - PolicyConstants.Resources.APPLICATION_INSTANCE - for app-instance publishing. - PolicyConstants.Resources.IT_RESOURCE_ENTITLEMENT - For entitlement publication.entityId
- valid entity id, requiredparamsMap
- - Map containing the pagination & sorting parameters.java.util.List listEntityPublicationsInScope(PolicyConstants.Resources entityType, java.lang.String scopeId, java.util.Map paramsMap)
entityType
- valid entity type, required. Currently supported are: - PolicyConstants.Resources.ROLE - for Role publishing. - PolicyConstants.Resources.APPLICATION_INSTANCE - for app-instance publishing. - PolicyConstants.Resources.IT_RESOURCE_ENTITLEMENT - For entitlement publication.scopeId
- scope for which publications are to be searchedparamsMap
- - Map containing the pagination & sorting parameters.java.util.List search(EntityPublicationSearchCriteria criteria, java.util.Map paramsMap)
SearchCriteria
. For atribute names allowed in the search criteria and sort criteria Attribute enum in EntityPublication class
criteria
- The search criteria based on which entries will be retrieved from the backend.configParams
- Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.
The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.
The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional.
The SORTORDER configuration parameter indicates the sorting order of the result, SortOrder.ASCENDING and SortOrder.DESCENDING. This parameter is optional.
AccessDeniedException
- if the logged-in user does not have the required authorization.java.util.List listEntityPublicationInScope(PolicyConstants.Resources entityType, java.lang.String entityId, java.lang.String scopeId, boolean includeHierarchy, java.util.Map paramsMap)
entityType
- valid entity type, required. Currently supported are: - PolicyConstants.Resources.ROLE - for Role publishing. - PolicyConstants.Resources.APPLICATION_INSTANCE - for app-instance publishing. - PolicyConstants.Resources.IT_RESOURCE_ENTITLEMENT - For entitlement publication.entityId
- valid entity id, optionalscopeId
- scope for which publications are to be searched.includeHierarchy
- if true, any indirect publications through parent hierarchy are included, otherwise excluded from the result.paramsMap
- - Map containing the pagination & sorting parameters.java.util.List addEntityPublications(java.util.List entityPublications, boolean publishDependentData)
entityPublications
- a list of entity publications with valid entity reference and scope reference.publishDependentData
- - Flag to indicate if the dependent data also needs to be published.boolean removeEntityPublications(java.util.List entityPublications, boolean unpublishDependentData)
entityPublications
- a list of entity publications to be removed.unpublishDependentData
- boolean parameter to determine if the dependent data also needs to be removed along with passed parent data.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |