org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common

Class Identity

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Identity

public class Identity
extends Object

A representation of the unique characteristics of a particular asset, without relying on a unique ID string. Two assets with the same identity may have different unique ID strings (eg. RIDs), but their Identity should still be equal.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Identity.StringType

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_PREFIX

Constructor Summary

Constructors

Constructor and Description
Identity(boolean partial) Creates a new empty identity.
Identity(List<Reference> context, String assetType, String assetName) Creates a new identity based on the identity characteristics provided.
Identity(List<Reference> context, String assetType, String assetName, String rid) Creates a new identity based on the identity characteristics provided.
Identity(List<Reference> context, String assetType, String assetName, String rid, boolean partial) Creates a new identity based on the identity characteristics provided.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAssetType() Returns the type of the asset represented by this identity.
static Identity	getFromString(String identity, IGCRestClient igcRestClient, Identity.StringType stringType) Builds an Identity based on an identity string (or null if unable to construct an Identity from the string).
static Identity	getFromString(String identity, IGCRestClient igcRestClient, Identity.StringType stringType, boolean warnOnNotFound) Builds an Identity based on an identity string (or null if unable to construct an Identity from the string).
String	getName() Returns the (display) name of the asset represented by this identity.
Identity	getParentIdentity() Returns the Identity of the parent that contains the entity identified by this Identity.
String	getRid() Returns the Repository ID (RID) of this identity (if available), or null.
IGCSearchConditionSet	getSearchCriteria() Composes the search criteria necessary to retrieve an IGC object with this identity, without relying on its RID.
static void	getSearchCriteriaForUserName(IGCSearchConditionSet igcSearchConditionSet, String name) Translate the provided full name into search criteria.
Identity	getUltimateParentIdentity() Returns the Identity of the ultimate parent (top-level ancestor) that contains the entity identified by this Identity.
int	hashCode()
static int	isIdentityString(String candidate) Return true if the provided string appears to be an identity string (partial or complete), or false otherwise.
boolean	isPartial() Returns true if this is a partial identity, or false if it is a full identity.
String	toString() Returns a unique string representation of the identity.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PREFIX

public static final String TYPE_PREFIX

See Also:

Constant Field Values

Constructor Detail

Identity

public Identity(boolean partial)

Creates a new empty identity.

Parameters:

partial - true if this is only a partial identity, false otherwise

Identity

public Identity(List<Reference> context,
                String assetType,
                String assetName)

Creates a new identity based on the identity characteristics provided.

Parameters:

context - the populated '_context' array from an asset

assetType - the type of the asset

assetName - the name of the asset

Identity

public Identity(List<Reference> context,
                String assetType,
                String assetName,
                String rid)

Creates a new identity based on the identity characteristics provided. (Also keeps a record of Repository ID (RID) for potential efficiency of parent traversal)

Parameters:

context - the populated '_context' array from an asset

assetType - the type of the asset

assetName - the name of the asset

rid - the Repository ID (RID) of the asset

Identity

public Identity(List<Reference> context,
                String assetType,
                String assetName,
                String rid,
                boolean partial)

Creates a new identity based on the identity characteristics provided.

Parameters:

context - the populated '_context' array from an asset

assetType - the type of the asset

assetName - the name of the asset

rid - the Repository ID (RID) of the asset

partial - true if this is only a partial identity, false otherwise

Method Detail

getParentIdentity

public Identity getParentIdentity()

Returns the Identity of the parent that contains the entity identified by this Identity.

If there is no parent identity (ie. this Identity represents a root-level asset with no container above it), will return null.

Returns:

Identity

getUltimateParentIdentity

public Identity getUltimateParentIdentity()

Returns the Identity of the ultimate parent (top-level ancestor) that contains the entity identified by this Identity.

If there is no parent identity (ie. this Identity represents a root-level asset with no container above it), will return itself.

Returns:

Identity

getRid

public String getRid()

Returns the Repository ID (RID) of this identity (if available), or null.

Returns:

String

getAssetType

public String getAssetType()

Returns the type of the asset represented by this identity.

Returns:

String

getName

public String getName()

Returns the (display) name of the asset represented by this identity.

Returns:

String

isPartial

public boolean isPartial()

Returns true if this is a partial identity, or false if it is a full identity.

Returns:

boolean

getSearchCriteria

public final IGCSearchConditionSet getSearchCriteria()

Composes the search criteria necessary to retrieve an IGC object with this identity, without relying on its RID.

Returns:

IGCSearchConditionSet

isIdentityString

public static int isIdentityString(String candidate)

Return true if the provided string appears to be an identity string (partial or complete), or false otherwise.

Parameters:

candidate - the string to test as an identity string

Returns:

int the count of identifying characteristics of an identity string (max 6)

getFromString

public static Identity getFromString(String identity,
                                     IGCRestClient igcRestClient,
                                     Identity.StringType stringType)
                              throws IGCParsingException

Builds an Identity based on an identity string (or null if unable to construct an Identity from the string).

Parameters:

identity - the string representing a qualified identity

igcRestClient - connectivity to an IGC environment

stringType - the type of string from which to construct the identity

Returns:

Identity

Throws:

IGCParsingException - if there is any issue parsing the identity string

See Also:

toString()

getFromString

public static Identity getFromString(String identity,
                                     IGCRestClient igcRestClient,
                                     Identity.StringType stringType,
                                     boolean warnOnNotFound)
                              throws IGCParsingException

Builds an Identity based on an identity string (or null if unable to construct an Identity from the string).

Parameters:

identity - the string representing a qualified identity

igcRestClient - connectivity to an IGC environment

stringType - the type of string from which to construct the identity

warnOnNotFound - indicates whether to log a warning (true) or not (false) in case the type inferred from the identity cannot be found

Returns:

Identity

Throws:

IGCParsingException - if there is any issue parsing the identity string

See Also:

toString()

getSearchCriteriaForUserName

public static void getSearchCriteriaForUserName(IGCSearchConditionSet igcSearchConditionSet,
                                                String name)

Translate the provided full name into search criteria.

Parameters:

igcSearchConditionSet - the search criteria to which to append

name - the name from which to build the criteria

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a unique string representation of the identity.

Overrides:

toString in class Object

Returns:

String