public interface IPolicyClient
PolicyClientFactory
Modifier and Type | Method and Description |
---|---|
void |
clearPolicyCache()
For each top-level save objects call from JAXR, the list of policies applicable for a (objectType, eventType)
pair will be cached in the policy client.
|
void |
continuePolicyAction(java.lang.String executeAsUser,
java.lang.String password,
PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message)
Continues with the next policy action.
|
void |
continuePolicyAction(java.lang.String executeAsUser,
java.lang.String password,
PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message,
boolean useSameConnection)
Continues with the next policy action.
|
void |
continuePolicyAction(java.lang.String executeAsUser,
java.lang.String password,
PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message,
boolean useSameConnection,
java.lang.String approvalStatus,
java.lang.String approvalFlowCompleterId,
java.lang.String approvalFlowCompletionTimestamp)
Continues with the next policy action.
|
IPolicyStatus |
executeConsumerRegistration(RegistryObject asset,
java.lang.String requestId,
java.lang.String usersAndGroupIds,
java.lang.String consumerApplicationIds)
Submits a Consumer Registration event to the Policy Engine.
|
IPolicyStatus |
executePostDelete(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PostDelete event.
|
IPolicyStatus |
executePostInsert(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PostInsert event.
|
IPolicyStatus |
executePostStateChange(RegistryObject regObj,
Concept fromState,
Concept toState)
Submits PostStateChange event to the Policy Engine.
|
IPolicyStatus |
executePostUpdate(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PostUpdate event.
|
IPolicyStatus |
executePreDelete(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PreDelete event.
|
IPolicyStatus |
executePreInsert(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PreInsert event.
|
IPolicyStatus |
executePreStateChange(RegistryObject regObj,
Concept fromState,
Concept toState)
Submits preStateChange event to the Policy Engine.
|
IPolicyStatus |
executePreUpdate(RegistryObject regObj)
Submits the registry object to the PolicyEngine with a PreUpdate event.
|
java.util.Collection |
getContextObjects(java.lang.String qualifier)
Gets the objects that are available in the policy context under the specified qualifier.
|
void |
log(PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message)
logs the entry to all appenders and triggers all registered listeners.
|
void |
log(PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message,
boolean useSameConnection)
logs the entry to all appenders and triggers all registered listeners.
|
void |
log(PolicyActionInstance policyAction,
ResultStatus status,
java.lang.String sessionId,
java.lang.String message,
boolean useSameConnection,
java.lang.String approvalStatus,
java.lang.String approvalFlowCompleterId,
java.lang.String approvalFlowCompletionTimestamp)
logs the entry to all appenders and triggers all registered listeners.
|
void |
onCollect(RegistryObject regObj)
Submits the registry object to the PolicyEngine with an onCollect event.
|
ResultStatus |
onConsumerRegistration(RegistryObject asset,
java.lang.String requestId,
java.lang.String usersAndGroupIds,
java.lang.String consumerApplicationIds)
Deprecated.
|
void |
onExport(RegistryObject registryObject,
java.util.Map<java.lang.String,java.lang.Object> parameterMap)
Submits the registry object to the PolicyEngine with an onExport event.
|
void |
onMove(RegistryObject regObj)
Submits the registry object to the PolicyEngine with an OnMove event.
|
void |
onPostDelete(RegistryObject regObj)
Deprecated.
|
void |
onPostInsert(RegistryObject regObj)
Deprecated.
|
void |
onPostUpdate(RegistryObject regObj)
Deprecated.
|
void |
onPreDelete(RegistryObject regObj)
Deprecated.
|
void |
onPreInsert(RegistryObject regObj)
Deprecated.
|
void |
onPreUpdate(RegistryObject regObj)
Deprecated.
|
java.util.List<java.lang.String> |
onTrigger(Policy policy,
java.util.List<RegistryObject> regObjs)
Submits the registry object to the PolicyEngine with an onTrigger event returns the collection of policy logs
|
java.lang.String |
onTrigger(Policy policy,
java.util.List<RegistryObject> registryObjects,
java.util.List<com.centrasite.jaxr.importexport.IEventCallback> policyCallbackList,
java.util.HashMap<java.lang.String,java.lang.Object> additionalInput)
Submits the registry object to the PolicyEngine with an onTrigger event.
|
java.lang.String |
onTrigger(Policy policy,
RegistryObject regObjs,
java.util.Map addlPolicyContextParms)
Submits the registry object to the PolicyEngine with an onTrigger event returns the policy log.
|
ResultStatus |
postStateChange(RegistryObject regObj,
Concept fromState,
Concept toState)
Deprecated.
|
ResultStatus |
preStateChange(RegistryObject regObj,
Concept fromState,
Concept toState)
Deprecated.
|
void |
resetParameterContext(java.lang.String qualifier)
Resets the parameter object from the policy context map.
|
void |
setParameterContext(java.lang.String qualifier,
java.lang.Object parameters)
Sets a parameter object into the context map for the policy execution with a qualifier.
|
@Deprecated void onPreInsert(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre-insertPolicyException
- if encounters an internal errorIPolicyStatus executePreInsert(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre-insertPolicyException
- if encounters an internal error@Deprecated void onPostInsert(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post insertPolicyException
- if encounters an internal errorIPolicyStatus executePostInsert(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- of type RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post insertPolicyException
- if encounters an internal error@Deprecated void onPreUpdate(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- of type RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre updatePolicyException
- if encounters an internal errorIPolicyStatus executePreUpdate(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- of type RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre updatePolicyException
- if encounters an internal error@Deprecated void onPostUpdate(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post updatePolicyException
- if encounters an internal errorIPolicyStatus executePostUpdate(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post updatePolicyException
- if encounters an internal error@Deprecated void onPreDelete(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre deletePolicyException
- if encounters an internal errorIPolicyStatus executePreDelete(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on pre deletePolicyException
- if encounters an internal error@Deprecated void onPostDelete(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post deletePolicyException
- if encounters an internal errorIPolicyStatus executePostDelete(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error while performing on post deletePolicyException
- if encounters an internal error@Deprecated ResultStatus preStateChange(RegistryObject regObj, Concept fromState, Concept toState) throws JAXRException, PolicyException
regObj
- RegistryObject for which the state change is initiatedfromState
- from state of the Registry ObjecttoState
- to state of the Registry ObjectJAXRException
- if encounters an internal error while performing on pre state changePolicyException
- if encounters an internal errorIPolicyStatus executePreStateChange(RegistryObject regObj, Concept fromState, Concept toState) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.fromState
- from state of the Registry ObjecttoState
- to state of the Registry ObjectJAXRException
- if encounters an internal error while performing on pre state changePolicyException
- if encounters an internal error@Deprecated ResultStatus postStateChange(RegistryObject regObj, Concept fromState, Concept toState) throws JAXRException, PolicyException
regObj
- RegistryObject for which the state change is initiatedfromState
- from state of the Registry ObjecttoState
- to state of the Registry ObjectJAXRException
- if encounters an internal error while performing on post state changePolicyException
- if encounters an internal errorIPolicyStatus executePostStateChange(RegistryObject regObj, Concept fromState, Concept toState) throws JAXRException, PolicyException
regObj
- RegistryObject for which the state change is initiatedfromState
- from state of the Registry ObjecttoState
- to state of the Registry ObjectJAXRException
- if encounters an internal error while performing on post state changePolicyException
- if encounters an internal error@Deprecated ResultStatus onConsumerRegistration(RegistryObject asset, java.lang.String requestId, java.lang.String usersAndGroupIds, java.lang.String consumerApplicationIds) throws JAXRException, PolicyException
asset
- Asset on which the Request is generatedrequestId
- Consumer Registration RequestusersAndGroupIds
- Users and Groups for which the request is madeconsumerApplicationIds
- ConsumerApplications for which the request is madeJAXRException
- if encounters an internal error while performing consumer registrationPolicyException
- if encounters an internal errorIPolicyStatus executeConsumerRegistration(RegistryObject asset, java.lang.String requestId, java.lang.String usersAndGroupIds, java.lang.String consumerApplicationIds) throws JAXRException, PolicyException
asset
- Asset on which the Request is generatedrequestId
- Consumer Registration RequestusersAndGroupIds
- Users and Groups for which the request is madeconsumerApplicationIds
- ConsumerApplications for which the request is madeJAXRException
- if encounters an internal error while performing consumer registrationPolicyException
- if encounters an internal errorjava.util.List<java.lang.String> onTrigger(Policy policy, java.util.List<RegistryObject> regObjs) throws JAXRException, PolicyException
policy
- PolicyInstance to be executedregObjs
- Registry Objects on which the Policy to be executed. If this is empty then all matching objects
will be choosen for executionString
objects.JAXRException
- if encounters an internal error on triggering the policyPolicyException
- if encounters an internal errorjava.lang.String onTrigger(Policy policy, RegistryObject regObjs, java.util.Map addlPolicyContextParms) throws JAXRException, PolicyException
policy
- PolicyInstance to be executedregObjs
- the Registry Objects on which the Policy to be executed.addlPolicyContextParms
- MapString
JAXRException
- if encounters an internal error on triggering the policyPolicyException
- if encounters an internal errorvoid log(PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message) throws JAXRException, PolicyException
policyAction
- PolicyActionInstance which needs to be loggedstatus
- Status of the executionsessionId
- Id of the sessionmessage
- Message of the executionJAXRException
- if encounters an internal error on triggering the policyPolicyException
- if encounters an internal errorvoid log(PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message, boolean useSameConnection) throws JAXRException, PolicyException
policyAction
- PolicyActionInstance which needs to be loggedstatus
- Status of the executionsessionId
- Id of the sessionmessage
- Message of the executionuseSameConnection
- JAXRException
- if encounters an internal error on loggingPolicyException
- if encounters an internal errorvoid log(PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message, boolean useSameConnection, java.lang.String approvalStatus, java.lang.String approvalFlowCompleterId, java.lang.String approvalFlowCompletionTimestamp) throws JAXRException, PolicyException
policyAction
- PolicyActionInstance which needs to be loggedstatus
- Status of the executionsessionId
- Id of the sessionmessage
- Message of the executionuseSameConnection
- approvalStatus
- The approval status whether it was rejected or approved.approvalFlowCompleterId
- The UDDI key of the user who completed(approved/rejected) the approval flow.approvalFlowCompletionTimestamp
- The time stamp (long as a String) when the approval flow was completed(approved/rejected).JAXRException
- if encounters an internal error on loggingPolicyException
- if encounters an internal errorvoid continuePolicyAction(java.lang.String executeAsUser, java.lang.String password, PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message) throws JAXRException, PolicyException
executeAsUser
- the user on which policy should continue.password
- the password for which policy should continuepolicyAction
- the next policy action to be executed.status
- the status of the next policy action.sessionId
- the current session ID.message
- the current message on the policy.JAXRException
- if encounters an internal error on loggingPolicyException
- if encounters an internal errorvoid continuePolicyAction(java.lang.String executeAsUser, java.lang.String password, PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message, boolean useSameConnection, java.lang.String approvalStatus, java.lang.String approvalFlowCompleterId, java.lang.String approvalFlowCompletionTimestamp) throws JAXRException, PolicyException
executeAsUser
- the user on which policy should continue.password
- the password for which policy should continuepolicyAction
- the next policy action to be executed.status
- the status of the next policy action.sessionId
- the current session ID.message
- the current message on the policy.useSameConnection
- the boolean value true
will continue with same connectionapprovalStatus
- The approval status whether it was rejected or approved.approvalFlowCompleterId
- The UDDI key of the user who completed(approved/rejected) the approval flow.approvalFlowCompletionTimestamp
- The time stamp (long as a String) when the approval flow was completed(approved/rejected).JAXRException
- if encounters an internal error on continuing policy actionPolicyException
- if encounters an internal errorvoid continuePolicyAction(java.lang.String executeAsUser, java.lang.String password, PolicyActionInstance policyAction, ResultStatus status, java.lang.String sessionId, java.lang.String message, boolean useSameConnection) throws JAXRException, PolicyException
executeAsUser
- the user on which policy should continue.password
- the password for which policy should continuepolicyAction
- the next policy action to be executed.status
- the status of the next policy action.sessionId
- the current session ID.message
- the current message on the policy.useSameConnection
- the boolean value true
will continue with same connectionJAXRException
- if encounters an internal error on continuing policy actionPolicyException
- if encounters an internal errorvoid clearPolicyCache()
void onMove(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the Registry Object to be movedJAXRException
- if encounters an internal error on movePolicyException
- if encounters an internal errorvoid onCollect(RegistryObject regObj) throws JAXRException, PolicyException
regObj
- the type of RegistryObject for which the event is generated.JAXRException
- if encounters an internal error on collectPolicyException
- if encounters an internal errorjava.lang.String onTrigger(Policy policy, java.util.List<RegistryObject> registryObjects, java.util.List<com.centrasite.jaxr.importexport.IEventCallback> policyCallbackList, java.util.HashMap<java.lang.String,java.lang.Object> additionalInput) throws JAXRException, PolicyException
policy
- the Policy
objectregistryObjects
- the collection RegistryObject
objectsadditionalInput
- the additionalInput which carries the eventspolicyCallbackList
- the list of policy call back objects.String
object.JAXRException
- if encounters an internal error on triggerPolicyException
- if encounters an internal errorvoid onExport(RegistryObject registryObject, java.util.Map<java.lang.String,java.lang.Object> parameterMap) throws JAXRException, PolicyException
registryObject
- the RegistryObject
parameterMap
- the parameterMap which takes onExport eventsJAXRException
- if encounters an internal error on exportPolicyException
- if encounters an internal errorvoid setParameterContext(java.lang.String qualifier, java.lang.Object parameters)
qualifier
- a qualifier (key for the used context Map)parameters
- any parametersvoid resetParameterContext(java.lang.String qualifier)
qualifier
- a qualifier (key for the used context Map)java.util.Collection getContextObjects(java.lang.String qualifier) throws java.lang.Exception
qualifier
- the qualifier values as String
java.lang.Exception
- if an internal error occurs