org.picketlink.idm.internal

Class RelationshipReference

java.lang.Object

org.picketlink.idm.model.AbstractAttributedType

org.picketlink.idm.internal.RelationshipReference

All Implemented Interfaces:

Serializable, AttributedType, Relationship

public final class RelationshipReference
extends AbstractAttributedType
implements Relationship

Adapter class that encapsulates a target Relationship instance and provides additional methods to resolve the referenced IdentityType instances.

This class is particularly used when using multiple stores to store different identity and relationship types. In this scenario, the referenced identity type may not be stored in the same store of the relationship, which requires to hold only an identifier-based reference to the referenced type.

Author:

Pedro Igor

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.idm.model.AttributedType

AttributedType.QUERY_ATTRIBUTE

Field Summary

Fields inherited from interface org.picketlink.idm.model.Relationship

IDENTITY

Fields inherited from interface org.picketlink.idm.model.AttributedType

ID

Constructor Summary

Constructors

Constructor and Description
RelationshipReference(Relationship relationship)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIdentityTypeReference(String descriptor, String referencedId) Add a reference to a IdentityType.
static String	formatId(IdentityType identityType) Return a formatted string representing the reference to the given IdentityType.
Set<String>	getDescriptors() Returns a Set of strings representing all registered identity type references.
String	getId() Returns the unique identifier for this instance
String	getIdentityType(String descriptor) Return the type given a descriptor.
String	getIdentityTypeId(String descriptor) Return the identifier of the identity type referenced by the descriptor.
String	getPartitionId(String descriptor) Return the identifier of the partition where the identity type is stored.
Relationship	getRelationship() Return the target relationship instance.

Methods inherited from class org.picketlink.idm.model.AbstractAttributedType

equals, getAttribute, getAttributes, getAttributesMap, hashCode, removeAttribute, setAttribute, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.picketlink.idm.model.AttributedType

getAttribute, getAttributes, removeAttribute, setAttribute, setId

Constructor Detail

RelationshipReference

public RelationshipReference(Relationship relationship)

Method Detail

getId

public String getId()

Description copied from interface: AttributedType

Returns the unique identifier for this instance

Specified by:

getId in interface AttributedType

Overrides:

getId in class AbstractAttributedType

Returns:

addIdentityTypeReference

public void addIdentityTypeReference(String descriptor,
                            String referencedId)

Add a reference to a IdentityType.

Parameters:

descriptor - The descriptor for the identity type. The descriptor usually matches the property name on the target relationship instance used to store the identity type instance.

referencedId - The identifier of the identity type.

getDescriptors

public Set<String> getDescriptors()

Returns a Set of strings representing all registered identity type references.

Descriptors have a format: typeName:partitionId:identityTypeId.

Returns:

getIdentityType

public String getIdentityType(String descriptor)

Return the type given a descriptor.

Parameters:

descriptor -

Returns:

getPartitionId

public String getPartitionId(String descriptor)

Return the identifier of the partition where the identity type is stored.

Parameters:

descriptor -

Returns:

getIdentityTypeId

public String getIdentityTypeId(String descriptor)

Return the identifier of the identity type referenced by the descriptor.

Parameters:

descriptor -

Returns:

getRelationship

public Relationship getRelationship()

Return the target relationship instance.

Returns:

formatId

public static String formatId(IdentityType identityType)

Return a formatted string representing the reference to the given IdentityType.

Parameters:

identityType -

Returns: