org.openmdx.security.authentication1.cci
Interface Segment

All Superinterfaces:

ContextCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, Segment, ViewCapable

public interface Segment
extends Segment

Method Summary

void	addAuthenticationContext(AuthenticationContext newValue)
void	addAuthenticationContext(String id, AuthenticationContext newValue)
void	addCredential(Credential newValue)
void	addCredential(String id, Credential newValue)
Collection	getAuthenticationContext() Retrieves a collection containing all the elements for the reference authenticationContext.
List	getAuthenticationContext(AuthenticationContextFilter filter) Retrieves the value for the reference authenticationContext for the specified filter.
List	getAuthenticationContext(AuthenticationContextQuery query) Retrieves the value for the reference authenticationContext for the specified query.
AuthenticationContext	getAuthenticationContext(String id) Retrieves the value for the reference authenticationContext for the specified qualifier attribute value.
Collection	getCredential() Retrieves a collection containing all the elements for the reference credential.
List	getCredential(CredentialFilter filter) Retrieves the value for the reference credential for the specified filter.
List	getCredential(CredentialQuery query) Retrieves the value for the reference credential for the specified query.
Credential	getCredential(String id) Retrieves the value for the reference credential for the specified qualifier attribute value.
void	removeAuthenticationContext(String id)
void	removeCredential(String id)

Methods inherited from interface org.openmdx.base.cci.Segment

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getAuthenticationContext

AuthenticationContext getAuthenticationContext(String id)

Retrieves the value for the reference authenticationContext for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAuthenticationContext

Collection getAuthenticationContext()

Retrieves a collection containing all the elements for the reference authenticationContext.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAuthenticationContext

List getAuthenticationContext(AuthenticationContextFilter filter)

Retrieves the value for the reference authenticationContext for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAuthenticationContext

List getAuthenticationContext(AuthenticationContextQuery query)

Retrieves the value for the reference authenticationContext for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAuthenticationContext

void addAuthenticationContext(String id,
                              AuthenticationContext newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAuthenticationContext

void addAuthenticationContext(AuthenticationContext newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAuthenticationContext

void removeAuthenticationContext(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getCredential

Credential getCredential(String id)

Retrieves the value for the reference credential for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getCredential

Collection getCredential()

Retrieves a collection containing all the elements for the reference credential.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getCredential

List getCredential(CredentialFilter filter)

Retrieves the value for the reference credential for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getCredential

List getCredential(CredentialQuery query)

Retrieves the value for the reference credential for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addCredential

void addCredential(String id,
                   Credential newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addCredential

void addCredential(Credential newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeCredential

void removeCredential(String id)

Throws:

JmiException - If the value cannot be removed for some reason.