org.openliberty.arisid
Interface IFindInteraction

All Superinterfaces:

IInteraction

All Known Implementing Classes:

Interaction

public interface IFindInteraction
extends IInteraction

An interface to an ArisID service provide used for finding subjects.

Method Summary

IDigitalSubject	doFind(java.util.List<IAttributeValue> attrFilterVals, java.util.Map<java.lang.String,IPolicy> dynamicConstraintsMap, javax.security.auth.Subject user) Method to find a single subject.
IDigitalSubject	doFind(java.util.List<IAttributeValue> attrFilterVals, javax.security.auth.Subject user) Method to find a single subject.
boolean	isFind()

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, isDelete, isModify, isRead, isSearch

Method Detail

isFind

boolean isFind()

Specified by:

isFind in interface IInteraction

doFind

IDigitalSubject doFind(java.util.List<IAttributeValue> attrFilterVals,
                       javax.security.auth.Subject user)
                       throws ConnectionException,
                              PolicyException,
                              NoSuchContextException,
                              NoSuchSubjectException,
                              SubjectNotUniqueException,
                              DeclarationException,
                              InvalidFilterException,
                              SchemaException,
                              MappingException

Method to find a single subject.

Parameters:

attrFilterVals - An array of IFilterValue and/or IAttributeValue objects that specify the comparison values for any AttrFilter objects contained in the declared filter for the transaction. The number of values specified must correspond exactly to the number specified in the declared filter. Use Filter.getCompareAttrValues() to obtain the values that need to be set.
IFilterValue allows for the capability for runtime setting of the comparison operator (contains, beginswith, etc).

user - The security credential under which the operation is to be performed

Returns:

String containing the mapped and authenticated subject key

Throws:

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

PolicyException - Occurs when the authentication 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 authenticate operation.

SubjectNotUniqueException - Occurs when the when more than one Subject is located and could not be uniquely authenticated.

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

InvalidFilterException - There is a problem with the declared filter or the provided filter values.

MappingException - is thrown when an error has occurred in mapping a filter or role to an appropriate search filter or in mapping a result.

SchemaException - is thrown when a filter or role cannot be matched or used appropriately.

doFind

IDigitalSubject doFind(java.util.List<IAttributeValue> attrFilterVals,
                       java.util.Map<java.lang.String,IPolicy> dynamicConstraintsMap,
                       javax.security.auth.Subject user)
                       throws ConnectionException,
                              PolicyException,
                              NoSuchContextException,
                              NoSuchSubjectException,
                              SubjectNotUniqueException,
                              DeclarationException,
                              InvalidFilterException,
                              SchemaException,
                              MappingException

Method to find a single subject.

Parameters:

attrFilterVals - An array of IFilterValue and/or IAttributeValue objects that specify the comparison values for any AttrFilter objects contained in the declared filter for the transaction. The number of values specified must correspond exactly to the number specified in the declared filter. Use Filter.getCompareAttrValues() to obtain the values that need to be set.
IFilterValue allows for the capability for runtime setting of the comparison operator (contains, beginswith, etc).

dynamicConstraintsMap - A map containing a set of dynamic constraints relevant to the transaction. The map index is either an attribute, predicate, or role name, or interaction name (to define policy at the interaction level). This parameter is used for things like specifying a localization constraint on an attribute.

user - The security credential under which the operation is to be performed

Returns:

String containing the mapped and authenticated subject key

Throws:

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

PolicyException - Occurs when the authentication 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 authenticate operation.

SubjectNotUniqueException - Occurs when the when more than one Subject is located and could not be uniquely authenticated.

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

InvalidFilterException - There is a problem with the declared filter or the provided filter values.

MappingException - is thrown when an error has occurred in mapping a filter or role to an appropriate search filter or in mapping a result.

SchemaException - is thrown when a filter or role cannot be matched or used appropriately.