Package eu.europa.esig.dss.model

Class CommonObjectIdentifier

java.lang.Object

eu.europa.esig.dss.model.CommonObjectIdentifier

All Implemented Interfaces:

ObjectIdentifier, OidAndUriBasedEnum, OidBasedEnum, OidDescription, UriBasedEnum, Serializable

Direct Known Subclasses:

CommonCommitmentType

public class CommonObjectIdentifier
extends Object
implements ObjectIdentifier

This class provides a basic implementation of ObjectIdentifier providing a possibility to create a customized ObjectIdentifierType signed property.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommonObjectIdentifier()	Default constructor instantiating object with null values

Method Summary

Modifier and Type	Method	Description
String	getDescription()	This method returns the literal description of the OID
String[]	getDocumentationReferences()	Returns a list of URI-based references NOTE: used in XAdES
String	getOid()	This method returns the OID value
ObjectIdentifierQualifier	getQualifier()	Returns Object Identifier Qualifier
String	getUri()	Returns a URI
void	setDescription(String description)	Sets text describing the ObjectIdentifierType object.
void	setDocumentationReferences(String... documentationReferences)	Sets references pointing to a documentation describing the ObjectIdentifierType Use : OPTIONAL
void	setOid(String oid)	Sets OID identifying the ObjectIdentifierType Use : CONDITIONAL (shall be present in CAdES, PAdES.
void	setQualifier(ObjectIdentifierQualifier qualifier)	Sets Qualifier defining the type of OID identifier used for ObjectIdentifierType.
void	setUri(String uri)	Sets URI identifying the ObjectIdentifierType Use : CONDITIONAL (should be present in XAdES, JAdES)

Methods inherited from class java.lang.Object

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

Constructor Details

CommonObjectIdentifier

public CommonObjectIdentifier()

Default constructor instantiating object with null values

Method Details

getUri

public String getUri()

Description copied from interface: UriBasedEnum

Returns a URI

Specified by:

getUri in interface UriBasedEnum

Returns:

String

setUri

public void setUri(String uri)

Sets URI identifying the ObjectIdentifierType Use : CONDITIONAL (should be present in XAdES, JAdES)

Parameters:

uri - String

getOid

public String getOid()

Description copied from interface: OidBasedEnum

This method returns the OID value

Specified by:

getOid in interface OidBasedEnum

Returns:

the OID value

setOid

public void setOid(String oid)

Sets OID identifying the ObjectIdentifierType Use : CONDITIONAL (shall be present in CAdES, PAdES. May be present in XAdES, JAdES). Note : when using OID in XAdES, a Qualifier shall be defined within the method setQualifier(qualifier). See EN 319 132-1 "5.1.2 The ObjectIdentifierType data type" for more information.

Parameters:

oid - String

getQualifier

public ObjectIdentifierQualifier getQualifier()

Description copied from interface: ObjectIdentifier

Returns Object Identifier Qualifier

Specified by:

getQualifier in interface ObjectIdentifier

Returns:

ObjectIdentifierQualifier

setQualifier

public void setQualifier(ObjectIdentifierQualifier qualifier)

Sets Qualifier defining the type of OID identifier used for ObjectIdentifierType. See EN 319 132-1 "5.1.2 The ObjectIdentifierType data type" for more information. Use : CONDITIONAL (shall be present XAdES when using OID identifier, but not URI) Note : used only in XAdES

Parameters:

qualifier - ObjectIdentifierQualifier

getDescription

public String getDescription()

Description copied from interface: OidDescription

This method returns the literal description of the OID

Specified by:

getDescription in interface OidDescription

Returns:

the OID description

setDescription

public void setDescription(String description)

Sets text describing the ObjectIdentifierType object. Use : OPTIONAL

Parameters:

description - String

getDocumentationReferences

public String[] getDocumentationReferences()

Description copied from interface: ObjectIdentifier

Returns a list of URI-based references NOTE: used in XAdES

Specified by:

getDocumentationReferences in interface ObjectIdentifier

Returns:

an array of URI String references

setDocumentationReferences

public void setDocumentationReferences(String... documentationReferences)

Sets references pointing to a documentation describing the ObjectIdentifierType Use : OPTIONAL

Parameters:

documentationReferences - array of Strings