Module jpms_dss_model

Package eu.europa.esig.dss.model

Class CommonObjectIdentifier

java.lang.Object

eu.europa.esig.dss.model.CommonObjectIdentifier

All Implemented Interfaces:

eu.europa.esig.dss.enumerations.ObjectIdentifier, eu.europa.esig.dss.enumerations.OidAndUriBasedEnum, eu.europa.esig.dss.enumerations.OidBasedEnum, eu.europa.esig.dss.enumerations.OidDescription, eu.europa.esig.dss.enumerations.UriBasedEnum, Serializable

Direct Known Subclasses:

CommonCommitmentType

public class CommonObjectIdentifier
extends Object
implements eu.europa.esig.dss.enumerations.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()
String[]	getDocumentationReferences()
String	getOid()
eu.europa.esig.dss.enumerations.ObjectIdentifierQualifier	getQualifier()
String	getUri()
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(eu.europa.esig.dss.enumerations.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()

Specified by:

getUri in interface eu.europa.esig.dss.enumerations.UriBasedEnum

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()

Specified by:

getOid in interface eu.europa.esig.dss.enumerations.OidBasedEnum

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 eu.europa.esig.dss.enumerations.ObjectIdentifierQualifier getQualifier()

Specified by:

getQualifier in interface eu.europa.esig.dss.enumerations.ObjectIdentifier

setQualifier

public void setQualifier(eu.europa.esig.dss.enumerations.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()

Specified by:

getDescription in interface eu.europa.esig.dss.enumerations.OidDescription

setDescription

public void setDescription(String description)

Sets text describing the ObjectIdentifierType object. Use : OPTIONAL

Parameters:

description - String

getDocumentationReferences

public String[] getDocumentationReferences()

Specified by:

getDocumentationReferences in interface eu.europa.esig.dss.enumerations.ObjectIdentifier

setDocumentationReferences

public void setDocumentationReferences(String... documentationReferences)

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

Parameters:

documentationReferences - array of Strings