org.openliberty.arisid
Interface IDeleteInteraction

All Superinterfaces:

IInteraction

All Known Implementing Classes:

Interaction

public interface IDeleteInteraction
extends IInteraction

An interface to an entity used for deleting Identities in an ArisID service.

Method Summary

void	doDelete(IPrincipalIdentifier subjectIdentifierKey, IPolicy dynamicConstraints, javax.security.auth.Subject user) Method to delete a subject from the attribute service.
void	doDelete(IPrincipalIdentifier subjectIdentifierKey, javax.security.auth.Subject user) Method to delete a subject from the attribute service.
boolean	isDelete()

Methods inherited from interface org.openliberty.arisid.IInteraction

appendNode, getAttributeDef, getAttributeIds, getAttributePolicyDef, getAttributeRef, getAttributeRefs, getAttributeService, getDescription, getEntityName, getFilter, getInteractionPolicyDef, getNameId, getOperationType, getPredicateDef, getPredicateIds, getPredicatePolicyDef, getPredicateRef, getPredicateRefs, getRoleDef, getRoleIds, getRolePolicyDef, getRoleRef, getRoleRefs, getTransactionPolicy, isAdd, isCompare, isFind, isModify, isRead, isSearch

Method Detail

isDelete

boolean isDelete()

Specified by:

isDelete in interface IInteraction

doDelete

void doDelete(IPrincipalIdentifier subjectIdentifierKey,
              javax.security.auth.Subject user)
              throws ConnectionException,
                     PolicyException,
                     NoSuchContextException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException,
                     DeclarationException

Method to delete a subject from the attribute service. Note that depending on policy the delete may not actually occur. From the perspective of the attribute authority, the delete is simply indicating that the client application is deleting the subject.

Parameters:

subjectIdentifierKey - the subject to be deleted

user - The Subject credential under which the delete operation is to be performed or null if the transaction is to be done using the application credential context alone.

Throws:

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the delete is refused due to policy restrictions

NoSuchContextException - Occurs when the Subject cannot be mapped to an appropriate attribute authority context.

NoSuchSubjectException - Occurs when no Subject was located for the delete operation.

SubjectNotUniqueException - Occurs when the delete would impact more than one Subject.

DeclarationException - The interaction was not declared as a Delete Interaction.

doDelete

void doDelete(IPrincipalIdentifier subjectIdentifierKey,
              IPolicy dynamicConstraints,
              javax.security.auth.Subject user)
              throws ConnectionException,
                     PolicyException,
                     NoSuchContextException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException,
                     DeclarationException

Method to delete a subject from the attribute service. Note that depending on policy the delete may not actually occur. From the perspective of the attribute authority, the delete is simply indicating that the client application is deleting the subject.

Parameters:

subjectIdentifierKey - the subject to be deleted

dynamicConstraints - A IPolicy object containing any transaction related constraints or null.

user - The Subject credential under which the delete operation is to be performed or null if the transaction is to be done using the application credential context alone.

Throws:

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the delete is refused due to policy restrictions

NoSuchContextException - Occurs when the Subject cannot be mapped to an appropriate attribute authority context.

NoSuchSubjectException - Occurs when no Subject was located for the delete operation.

SubjectNotUniqueException - Occurs when the delete would impact more than one Subject.

DeclarationException - The interaction was not declared as a Delete Interaction.