com.sap.security.core.server.ssf
Class SsfRefXMLList

java.lang.Object
  |
  +--com.sap.security.core.server.ssf.SsfRefXMLList

public class SsfRefXMLList
extends java.lang.Object

Class for representing a list of XML reference information.

See Also:
SsfRefXMLInfo

Constructor Summary
SsfRefXMLList()
           
 
Method Summary
 boolean add(SsfRefXMLInfo info)
          Add an entry to the list.
 void clear()
          Clear the list.
 SsfRefXMLInfo get(int i)
          Get the i-th entry from the list.
 java.lang.String getIdLocalName()
          Get local name of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
 java.lang.String getIdURI()
          Get namespace URI of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
 com.sap.engine.lib.xml.signature.transform.TransformationFactory getTransformationFactory()
          Get the transformation factory (see SAP XML Toolkit).
 boolean setIdAttribute(java.lang.String localName, java.lang.String uri)
          Set local name and namespace URI of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
 void setTransformationFactory(com.sap.engine.lib.xml.signature.transform.TransformationFactory transFact)
          Set the transformation factory (see SAP XML Toolkit).
 int size()
          Get the size of the list.
 java.lang.String toString()
          Get description of the reference list
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SsfRefXMLList

public SsfRefXMLList()
Method Detail

setIdAttribute

public boolean setIdAttribute(java.lang.String localName,
                              java.lang.String uri)
Set local name and namespace URI of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
Parameters:
localName - local name of Id attribute (default: Id)
uri - namespace uri of Id attribute (default: null)

getIdLocalName

public java.lang.String getIdLocalName()
Get local name of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
Returns:
local name of Id attribute

getIdURI

public java.lang.String getIdURI()
Get namespace URI of attribute, which will be considered as Id attribute (relevant only, if same document references are used)
Returns:
namespace uri of Id attribute (may be null)

add

public boolean add(SsfRefXMLInfo info)
Add an entry to the list.
Parameters:
info - XML reference information to be added.

clear

public void clear()
Clear the list.

get

public SsfRefXMLInfo get(int i)
Get the i-th entry from the list.
Returns:
XML reference information
Throws:
IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).

size

public int size()
Get the size of the list.
Returns:
number of XML reference infos

setTransformationFactory

public void setTransformationFactory(com.sap.engine.lib.xml.signature.transform.TransformationFactory transFact)
Set the transformation factory (see SAP XML Toolkit). Applies to signature verfication only.
Parameters:
transFact - transformation factory

getTransformationFactory

public com.sap.engine.lib.xml.signature.transform.TransformationFactory getTransformationFactory()
Get the transformation factory (see SAP XML Toolkit). Applies to signature verfication only.
Returns:
transformation factory

toString

public java.lang.String toString()
Get description of the reference list
Overrides:
toString in class java.lang.Object
Returns:
string containing the description