es.gob.afirma.tsl.parsing.impl.common

Class TSLObject

java.lang.Object

es.gob.afirma.tsl.parsing.impl.common.TSLObject

All Implemented Interfaces:

ITSLObject, java.io.Serializable

public class TSLObject
extends java.lang.Object
implements ITSLObject

Class that represents a TSL object with the principal functions (access information) regardless it implementation.

Project:

Library for the integration with the services of @Firma, eVisor and TS@.

Version:

1.1, 15/06/2021.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TSLObject() Constructor method for the class TSLObject.java.

Method Summary

Modifier and Type	Method and Description
void	addNewTrustServiceProvider(TrustServiceProvider tsp) Adds a new trust service provider to the list associated to this TSL.
void	buildTSLFromXMLcheckValues(java.io.InputStream isParam) Method that builds the TSL data from a input XML.
void	buildTSLFromXMLcheckValues(java.io.InputStream is, boolean checkSignature) Method that builds the TSL data from a input XML.
void	checkTSLValues() Checks all the actual values assigned to this TSL as the concrecte specification and version requires.
byte[]	checkValuesBuildXMLfromTSL() Method that check that the data of the TSL is correct as the specification and version requires.
java.lang.String	getID() Gets the ID attribute from the TrustServiceStatus element.
SchemeInformation	getSchemeInformation() Gets the scheme information of the TSL.
org.w3.x2000.x09.xmldsig.SignatureType	getSignature() Gets the TSL signature.
java.util.List<TrustServiceProvider>	getTrustServiceProviderList() Gets the list with all the Trust Services Providers associated to this TSL.
java.lang.String	getTslSpecification() Gets the value of the attribute tslSpecification.
java.lang.String	getTslSpecificationVersion() Gets the value of the attribute tslSpecificationVersion.
java.net.URI	getTSLTag() Gets the URI that represents the tag attribute for the TrustServiceStatus element.
boolean	isThereSomeTrustServiceProvider() Checks if exists at least one Trust Service Provider associated to this TSL.
void	setID(java.lang.String id) Sets the ID attribute for the TSL.
void	setSchemeInformation(SchemeInformation si) Sets the scheme information associated to this TSL.
void	setSignature(org.w3.x2000.x09.xmldsig.SignatureType dsSignature) Sets the XML Signature for the TSL.
void	setTslSpecification(java.lang.String tslSpecification) Sets the value of the attribute tslSpecification.
void	setTslSpecificationVersion(java.lang.String tslSpecificationVersion) Sets the value of the attribute tslSpecificationVersion.
void	setTSLTag(java.net.URI tag) Sets the URI that represents the tag attribute for the TrustServiceStatus element.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSLObject

public TSLObject()

Constructor method for the class TSLObject.java.

Method Detail

getTSLTag

public final java.net.URI getTSLTag()

Gets the URI that represents the tag attribute for the TrustServiceStatus element.

Specified by:

getTSLTag in interface ITSLObject

Returns:

URI that represents the tag attribute for the TrustServiceStatus element.

See Also:

ITSLObject.getTSLTag()

getTslSpecification

public java.lang.String getTslSpecification()

Gets the value of the attribute tslSpecification.

Returns:

the value of the attribute tslSpecification.

setTslSpecification

public void setTslSpecification(java.lang.String tslSpecification)

Sets the value of the attribute tslSpecification.

Parameters:

tslSpecification - The value for the attribute tslSpecification.

getTslSpecificationVersion

public java.lang.String getTslSpecificationVersion()

Gets the value of the attribute tslSpecificationVersion.

Returns:

the value of the attribute tslSpecificationVersion.

setTslSpecificationVersion

public void setTslSpecificationVersion(java.lang.String tslSpecificationVersion)

Sets the value of the attribute tslSpecificationVersion.

Parameters:

tslSpecificationVersion - The value for the attribute tslSpecificationVersion.

setTSLTag

public final void setTSLTag(java.net.URI tag)
                     throws TSLArgumentException

Sets the URI that represents the tag attribute for the TrustServiceStatus element.

Specified by:

setTSLTag in interface ITSLObject

Parameters:

tag - URI to set.

Throws:

TSLArgumentException - In case of the input parameter is null or not well formed.

See Also:

ITSLObject.setTSLTag(java.net.URI)

getID

public final java.lang.String getID()

Gets the ID attribute from the TrustServiceStatus element.

Specified by:

getID in interface ITSLObject

Returns:

String with the ID of the TrustServiceStatus element. null if not is defined.

See Also:

ITSLObject.getID()

setID

public final void setID(java.lang.String id)

Sets the ID attribute for the TSL.

Specified by:

setID in interface ITSLObject

Parameters:

id - String that represents the ID to set. It can be null.

See Also:

ITSLObject.setID(java.lang.String)

getSchemeInformation

public final SchemeInformation getSchemeInformation()

Gets the scheme information of the TSL.

Specified by:

getSchemeInformation in interface ITSLObject

Returns:

representation object not dependent of the TSL implementation and version that represents the scheme information of this TSL.

See Also:

ITSLObject.getSchemeInformation()

setSchemeInformation

public final void setSchemeInformation(SchemeInformation si)
                                throws TSLArgumentException

Sets the scheme information associated to this TSL.

Specified by:

setSchemeInformation in interface ITSLObject

Parameters:

si - Scheme information to be associated to this TSL.

Throws:

TSLArgumentException - In case of the input parameter is null or not well formed.

See Also:

ITSLObject.setSchemeInformation(es.gob.afirma.tsl.parsing.impl.common.SchemeInformation)

getTrustServiceProviderList

public final java.util.List<TrustServiceProvider> getTrustServiceProviderList()

Gets the list with all the Trust Services Providers associated to this TSL.

Specified by:

getTrustServiceProviderList in interface ITSLObject

Returns:

list with all the Trust Services Providers associated to this TSL, if there is not, then null.

See Also:

ITSLObject.getTrustServiceProviderList()

addNewTrustServiceProvider

public final void addNewTrustServiceProvider(TrustServiceProvider tsp)
                                      throws TSLArgumentException

Adds a new trust service provider to the list associated to this TSL.

Specified by:

addNewTrustServiceProvider in interface ITSLObject

Parameters:

tsp - Trust Service Provider to add. It can not be null.

Throws:

TSLArgumentException - In case of the input parameter is null or not well formed.

See Also:

ITSLObject.addNewTrustServiceProvider(es.gob.afirma.tsl.parsing.impl.common.TrustServiceProvider)

isThereSomeTrustServiceProvider

public final boolean isThereSomeTrustServiceProvider()

Checks if exists at least one Trust Service Provider associated to this TSL.

Specified by:

isThereSomeTrustServiceProvider in interface ITSLObject

Returns:

true if exists at least one, otherwise false.

See Also:

ITSLObject.isThereSomeTrustServiceProvider()

getSignature

public final org.w3.x2000.x09.xmldsig.SignatureType getSignature()

Gets the TSL signature.

Specified by:

getSignature in interface ITSLObject

Returns:

TSL signature.

See Also:

ITSLObject.getSignature()

setSignature

public final void setSignature(org.w3.x2000.x09.xmldsig.SignatureType dsSignature)

Sets the XML Signature for the TSL.

Specified by:

setSignature in interface ITSLObject

Parameters:

dsSignature - XML Signature to set for this TSL.

See Also:

ITSLObject.setSignature(org.w3.x2000.x09.xmldsig.SignatureType)

checkTSLValues

public final void checkTSLValues()
                          throws TSLMalformedException

Checks all the actual values assigned to this TSL as the concrecte specification and version requires.

Specified by:

checkTSLValues in interface ITSLObject

Throws:

TSLMalformedException - In case of some data does not exist or has not a correct value.

See Also:

ITSLObject.checkTSLValues()

buildTSLFromXMLcheckValues

public final void buildTSLFromXMLcheckValues(java.io.InputStream isParam)
                                      throws TSLArgumentException,
                                             TSLParsingException,
                                             TSLMalformedException

Method that builds the TSL data from a input XML. This process overwrites the actual information of the object, but if there is some error parsing the XML, no data will be changed. When the data is parsed, then is checked if it has the correct values as the specification and version requires.

Specified by:

buildTSLFromXMLcheckValues in interface ITSLObject

Parameters:

isParam - InputStream Input Stream of the XML (TSL representation).

Throws:

TSLArgumentException - In case of the input parameter is null.

TSLParsingException - In case of some error parsing the XML input stream.

TSLMalformedException - In case of some data does not exist or has not a correct value.

See Also:

ITSLObject.buildTSLFromXMLcheckValues(java.io.InputStream)

buildTSLFromXMLcheckValues

public final void buildTSLFromXMLcheckValues(java.io.InputStream is,
                                             boolean checkSignature)
                                      throws TSLArgumentException,
                                             TSLParsingException,
                                             TSLMalformedException

Method that builds the TSL data from a input XML. This process overwrites the actual information of the object, but if there is some error parsing the XML, no data will be changed. When the data is parsed, then is checked if it has the correct values as the specification and version requires.

Specified by:

buildTSLFromXMLcheckValues in interface ITSLObject

Parameters:

is - InputStream Input Stream of the XML (TSL representation).

checkSignature - Flag that indicates if the TSL signature must be checked (true).

Throws:

TSLArgumentException - In case of the input parameter is null.

TSLParsingException - In case of some error parsing the XML input stream.

TSLMalformedException - In case of some data does not exist or has not a correct value.

See Also:

ITSLObject.buildTSLFromXMLcheckValues(java.io.InputStream, boolean)

checkValuesBuildXMLfromTSL

public final byte[] checkValuesBuildXMLfromTSL()
                                        throws TSLMalformedException,
                                               TSLEncodingException

Method that check that the data of the TSL is correct as the specification and version requires. After this, builds the XML representation (concrete specification and version) of the TSL.

Specified by:

checkValuesBuildXMLfromTSL in interface ITSLObject

Returns:

byte array that represents the XML of the TSL.

Throws:

TSLMalformedException - In case of some data does not exist or has not a correct value.

TSLEncodingException - In case of some error encoding the TSL.

See Also:

ITSLObject.checkValuesBuildXMLfromTSL()