|
Oracle Role Manager Java API Reference 10g (10.1.4) E14613-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Server
The interface by way of which all clients interact with the server. Specifically, this interface is the one published by the Server EJB, allowing Java-based clients to interact with the server process.
Field Summary | |
---|---|
static long |
NO_TRANSACTION A transaction ID indicating the lack of a business transaction ( -1 ). |
Method Summary | |
---|---|
IdentityToken |
authenticatePerson(java.lang.String ssoToken) Authenticates as a person with the provided the user ID. |
IdentityToken |
authenticatePersonFromCredentials(java.lang.String username, java.lang.String password) Authenticates as a person with the provided username and password. |
IdentityToken |
authenticateSystemUser(java.lang.String username, java.lang.String password) Authenticates as a system user with the provided the user ID and password. |
ServerBusinessTransaction |
begin(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, java.util.Map argumentSet) Begins a new business transaction. |
void |
cancelBusinessTransaction(IdentityToken identityToken, long transactionId) Cancels an existing business transaction. |
OperationVerificationResponse[] |
checkOperation(IdentityToken identityToken, OperationVerificationRequest[] operationVerificationRequests, boolean fullyValidate, long transactionId) Requests verification for the specified number of operation verification requests. |
boolean |
forwardBusinessTransaction(IdentityToken identityToken, long transactionId) Forwards an existing business transaction. |
java.util.List |
getAllHierarchyNodes(IdentityToken identityToken, EntityKey entityKey, long transactionId) Gets all ServerHierarchyNode objects relating to a particular object. |
ServerBusinessTransaction |
getBusinessTransaction(IdentityToken identityToken, long transactionId) Gets an existing business transaction by the provided identity and transaction identifiers. |
ServerConstraintViolation[] |
getConstraintViolations(IdentityToken identityToken, long transactionId) Gets any outstanding constraint violations from a business transaction. |
java.util.List |
getHierarchyChildren(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, java.util.Set entityTypes, long transactionId) Gets the child nodes of the specified entity in a specified hierarchy. |
ServerHierarchyNode |
getHierarchyNode(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, long transactionId) Gets a ServerHierarchyNode relating to a particular object in a particular hierarchy. |
java.util.List |
getHierarchyParents(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, long transactionId) Gets the parent nodes (recursive) of the specified entity in the particular hierarchy. |
ServerEntity |
getHierarchyRoot(IdentityToken identityToken, java.lang.String hierarchyType, long transactionId) Gets the ServerEntity that represents the root object of the hierarchy type. |
java.io.Serializable |
getIdentityTokenData(byte[] key) Gets updated identity token data. |
ServerEntity |
getMixin(IdentityToken identityToken, EntityKey entityKey, java.lang.String mixinType, long transactionId) Gets the mix-in entity of the specified entity. |
java.util.List |
getRelatedObjects(IdentityToken identityToken, EntityKey entityKey, java.lang.String relationshipPath, long transactionId) Gets all of the related objects based on the specified relationship path. |
ServerAuditSummary |
getServerAuditSummary(IdentityToken identityToken, EntityKey entityKey) Gets the ServerAuditSummary that represents the audit summary data for a particular entity. |
ServerChangeSummary |
getServerChangeSummary(IdentityToken identityToken, EntityKey entityKey, java.lang.String attributeName) Gets the ServerChangeSummary that represents the change summary data for a particular entity's attribute. |
ServerMetaData |
getServerMetaData(java.util.Locale locale) Gets localized ServerMetaData. |
boolean |
hasHierarchyChildren(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, java.util.Set entityTypes, long transactionId) Gets the child nodes of the specified entity in a specified hierarchy. |
java.util.List |
lookup(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, java.util.List keys, long transactionId) Invokes a lookup operation on the server. |
boolean |
quickValidate(IdentityToken identityToken, long transactionId) Runs lightweight validation tests. |
ServerPaginatedResultSet |
resolvePersonApprovers(IdentityToken identityToken, FilterCriterion personIdentificationFilter, FilterCriterion approverRoleIdentificationFilter, java.util.Set columnNames, long transactionId) Finds those persons that are approvers for the person identified using the specified approver role ID. |
ServerPaginatedResultSet |
search(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, CriterionSet criteria, ColumnSet columnSet, long transactionId) Invokes a search operation on the server. |
java.util.Map |
supplement(IdentityToken identityToken, long transactionId, java.lang.String definitionId, java.lang.String operationId, java.lang.String localName, java.util.Map argumentSet) Supplements a business transaction. |
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Field Detail |
---|
static final long NO_TRANSACTION
-1
).
Method Detail |
---|
IdentityToken authenticateSystemUser(java.lang.String username, java.lang.String password) throws javax.security.auth.login.LoginException, java.rmi.RemoteException
username
- username (userID) to authenticate withpassword
- password to authenticate with that should match the stored pasword associated with the provided usernamejavax.security.auth.login.LoginException
- if the login fails for any reasonjava.rmi.RemoteException
- if there is a general problem with the serverIdentityToken authenticatePerson(java.lang.String ssoToken) throws javax.security.auth.login.LoginException, java.rmi.RemoteException
ssoToken
- username to authenticate withjavax.security.auth.login.LoginException
- if the login fails for any reasonjava.rmi.RemoteException
- if there is a general problem with the serverIdentityToken authenticatePersonFromCredentials(java.lang.String username, java.lang.String password) throws javax.security.auth.login.LoginException, java.rmi.RemoteException
username
- username (userID) to authenticate withpassword
- password to authenticate with that should match the stored pasword associated with the provided usernamejavax.security.auth.login.LoginException
- if the login fails for any reasonjava.rmi.RemoteException
- if there is a general problem with the serverjava.io.Serializable getIdentityTokenData(byte[] key) throws java.rmi.RemoteException, ServerException
key
- IdentityToken's key for which to get updated datajava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverIdentityToken.getKey()
, IdentityToken.update(Object)
ServerMetaData getServerMetaData(java.util.Locale locale) throws java.rmi.RemoteException, ServerException
locale
- Locale for which to localize the metadata.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.List lookup(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, java.util.List keys, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userdefinitionId
- ID of the definition from which the operation originatesoperationId
- ID of the operation to invokekeys
- List of identifiers of the object to look up (one per object)transactionId
- transaciton ID for the lookupList
of ServerEntity objects that have been looked up by this operationjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerBusinessTransaction begin(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, java.util.Map argumentSet) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userdefinitionId
- ID of the definition that the operation originates fromoperationId
- ID of the operation to invokeargumentSet
- Map of arguments to invoke the operationjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerBusinessTransaction getBusinessTransaction(IdentityToken identityToken, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the usertransactionId
- transaction ID of the transaction to retrievejava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.Map supplement(IdentityToken identityToken, long transactionId, java.lang.String definitionId, java.lang.String operationId, java.lang.String localName, java.util.Map argumentSet) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the usertransactionId
- ID identifying the transaction to supplementdefinitionId
- ID of the definition from which the operation originatesoperationId
- ID of the operation to invokelocalName
- local ID of the operation if a transaction-bound supplemental operationargumentSet
- Map of arguments to invoke the operationjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverboolean forwardBusinessTransaction(IdentityToken identityToken, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the usertransactionId
- transaction ID of the transaction to forwardtrue
if the forward operation immediately completed the business transaction, otherwise false
.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerPaginatedResultSet search(IdentityToken identityToken, java.lang.String definitionId, java.lang.String operationId, CriterionSet criteria, ColumnSet columnSet, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userdefinitionId
- ID of the definition from which the operation originatesoperationId
- ID of the operation to invokecriteria
- search criteria with which to filter the resultscolumnSet
- ColumnSet data to control the returned results (columns and sort orders)transactionId
- transaction ID within which to do the searchjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerConstraintViolation[] getConstraintViolations(IdentityToken identityToken, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the usertransactionId
- transaction ID within which to look for constraint violationsjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the servervoid cancelBusinessTransaction(IdentityToken identityToken, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the usertransactionId
- transaction ID of the transaction to canceljava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerHierarchyNode getHierarchyNode(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity on which to look for a ServerHierarchyNodehierarchyType
- type of hierarchytransactionId
- transaction ID within which to do the lookupjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.List getAllHierarchyNodes(IdentityToken identityToken, EntityKey entityKey, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity on which to look for ServerHierarchyNode objectstransactionId
- transaction ID within which to do the lookupjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverboolean hasHierarchyChildren(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, java.util.Set entityTypes, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity of which to get childrenhierarchyType
- type of hierarchyentityTypes
- Set of object types to filter the children by or empty if no filtering is requiredtransactionId
- transaction ID within which to do the searchtrue
if node has children of the specified entity, otherwise false
.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.List getHierarchyChildren(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, java.util.Set entityTypes, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity of which to get childrenhierarchyType
- type of hierarchyentityTypes
- Set of object types to filter the children by or empty if no filtering is requiredtransactionId
- transaction ID within which to do the searchjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.List getHierarchyParents(IdentityToken identityToken, EntityKey entityKey, java.lang.String hierarchyType, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity of which to get parentshierarchyType
- type of hierarchytransactionId
- transaction ID within which to do the searchjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerEntity getMixin(IdentityToken identityToken, EntityKey entityKey, java.lang.String mixinType, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity of which to get the mix-inmixinType
- type of mix-intransactionId
- transaction ID within which to do the lookupjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerEntity getHierarchyRoot(IdentityToken identityToken, java.lang.String hierarchyType, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userhierarchyType
- type of hierarchytransactionId
- transaction ID within which to do the lookupjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerPaginatedResultSet resolvePersonApprovers(IdentityToken identityToken, FilterCriterion personIdentificationFilter, FilterCriterion approverRoleIdentificationFilter, java.util.Set columnNames, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userpersonIdentificationFilter
- filter to use to identify the specific subject of the approvalapproverRoleIdentificationFilter
- filter to use to identify the specific approval rolecolumnNames
- Set of column names of values to filtertransactionId
- transaction ID within which to do the lookupjava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if a failure occurs while resolving the approver role.OperationVerificationResponse[] checkOperation(IdentityToken identityToken, OperationVerificationRequest[] operationVerificationRequests, boolean fullyValidate, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the useroperationVerificationRequests
- set of operation verification requests that require the server to check.fullyValidate
- a flag to indicate whether to do a full validation or just authorization checkstransactionId
- ID of the ongoing business transaction.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerAuditSummary getServerAuditSummary(IdentityToken identityToken, EntityKey entityKey) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- entity identifier with which to locate the audit summary datajava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverjava.util.List getRelatedObjects(IdentityToken identityToken, EntityKey entityKey, java.lang.String relationshipPath, long transactionId) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- key for the entity of which to get the mix-inrelationshipPath
- relationshiup path to traversetransactionId
- ID of the transaction within which to do the lookupList
of ServerEntity
s representing the related objects.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverboolean quickValidate(IdentityToken identityToken, long transactionId) throws java.rmi.RemoteException, ServerException
getConstraintViolations(IdentityToken,long)
method.identityToken
- IdentityToken that identifies the usertransactionId
- ID of the transaction to validatetrue
if the validation succeeds, otherwise false
.java.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the serverServerChangeSummary getServerChangeSummary(IdentityToken identityToken, EntityKey entityKey, java.lang.String attributeName) throws java.rmi.RemoteException, ServerException
identityToken
- IdentityToken that identifies the userentityKey
- entity identifier with which to locate the change summary dataattributeName
- attribute name for the change summary datajava.rmi.RemoteException
- if there is a general problem with the remote serverServerException
- if there is a logical problem on the server
|
Oracle Role Manager Java API Reference 10g (10.1.4) E14613-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |