AbstractMetadataContainer (OpenSAML 3.x utility extensions

java.lang.Object
- se.litsec.opensaml.saml2.metadata.AbstractMetadataContainer<T>

Type Parameters:

T - the contained type

All Implemented Interfaces:

MetadataContainer<T>

Direct Known Subclasses:

EntitiesDescriptorContainer, EntityDescriptorContainer
```
public abstract class AbstractMetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
extends Object
implements MetadataContainer<T>
```
Abstract base class for the MetadataContainer interface.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_DESCRIPTOR_ID_SIZE` Default size for the ID attribute string.
`static float`	`DEFAULT_UPDATE_FACTOR` The default update factor for the metadata - 0,75 (75%), i.e.
`static Duration`	`DEFAULT_VALIDITY` The default validity for metadata - one week.
`protected T`	`descriptor` The encapsulated descriptor element.
`protected int`	`idSize` The size of the ID attribute string.
`protected X509Credential`	`signatureCredentials` The signature credentials for signing the metadata entry.
`protected float`	`updateFactor` The update factor.
`protected Duration`	`validity` The validity time for created entries.

Constructor Summary

Constructors
Constructor and Description
`AbstractMetadataContainer(T descriptor, X509Credential signatureCredentials)` Constructor assigning the encapsulated descriptor element.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`assignID(T descriptor, String id)` Assigns the supplied id to the ID attribute of the descriptor.
`T`	`cloneDescriptor()` Returns a deep clone of the descriptor element that is encapsulated by this object.
`T`	`getDescriptor()` Returns the metadata element that is encapsulated by this object.
`protected abstract String`	`getID(T descriptor)` Returns the ID attribute of the supplied descriptor.
`int`	`getIdSize()` Returns the size of the ID attribute that is generated.
`protected abstract String`	`getLogString(T descriptor)` Returns a log string of the supplied descriptor.
`float`	`getUpdateFactor()` Returns the factor (between 0 and 1) that is used to compute whether it is time to update the contained descriptor.
`Duration`	`getValidity()` Returns the duration of the validity that the encapsulated descriptor has.
`Element`	`marshall()` Marshals the encapsulated descriptor into its XML representation.
`void`	`setIdSize(int idSize)` Assigns the size of the ID attribute that is generated.
`void`	`setUpdateFactor(float updateFactor)` Assigns the factor (between 0 and 1) that is used to compute whether it is time to update the contained descriptor.
`void`	`setValidity(Duration validity)` Assigns the duration of the validity that the encapsulated `EntityDescriptor` should have.
`T`	`sign()` Signs the encapsulated descriptor using the signature credentials configured for this object.
`T`	`update(boolean sign)` Updates the encapsulated descriptor with a newly generated ID, a validity time according to this object's configuration, and then optionally signs the record.
`boolean`	`updateRequired(boolean signatureRequired)` Predicate that returns `true` if the contained descriptor needs to be updated regarding its signature status and validity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_VALIDITY
```
public static final Duration DEFAULT_VALIDITY
```
    The default validity for metadata - one week.
  - DEFAULT_UPDATE_FACTOR
```
public static final float DEFAULT_UPDATE_FACTOR
```
    The default update factor for the metadata - 0,75 (75%), i.e. "update the metadata when less than 75% of its original validity time remains".
    
    See Also:
    
    getUpdateFactor(), Constant Field Values
  - DEFAULT_DESCRIPTOR_ID_SIZE
```
public static final int DEFAULT_DESCRIPTOR_ID_SIZE
```
    Default size for the ID attribute string.
    
    See Also:
    
    Constant Field Values
  - descriptor
```
protected T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject descriptor
```
    The encapsulated descriptor element.
  - validity
```
protected Duration validity
```
    The validity time for created entries.
  - updateFactor
```
protected float updateFactor
```
    The update factor.
  - idSize
```
protected int idSize
```
    The size of the ID attribute string.
  - signatureCredentials
```
protected X509Credential signatureCredentials
```
    The signature credentials for signing the metadata entry.
- Constructor Detail
  - AbstractMetadataContainer
```
public AbstractMetadataContainer(T descriptor,
                                 X509Credential signatureCredentials)
```
    Constructor assigning the encapsulated descriptor element.
    
    Parameters:
    
    descriptor - the descriptor object
    
    signatureCredentials - the signature credentials for signing the descriptor. May be null, but then no signing will be possible
- Method Detail
  - getDescriptor
```
public T getDescriptor()
```
    Returns the metadata element that is encapsulated by this object.
    
    Specified by:
    
    getDescriptor in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    a descriptor object
  - cloneDescriptor
```
public T cloneDescriptor()
                  throws MarshallingException,
                         UnmarshallingException
```
    Returns a deep clone of the descriptor element that is encapsulated by this object.
    
    Specified by:
    
    cloneDescriptor in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    an copied descriptor object
    
    Throws:
    
    MarshallingException - for marshalling errors of the object
    
    UnmarshallingException - for unmarshalling errors of the object
  - updateRequired
```
public boolean updateRequired(boolean signatureRequired)
```
    Predicate that returns true if the contained descriptor needs to be updated regarding its signature status and validity. The method will also take into account the update interval configured for this instance of the container.
    
    Specified by:
    
    updateRequired in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Parameters:
    
    signatureRequired - should be set if signatures are required for a entry to be regarded valid
    
    Returns:
    
    if the encapsulated descriptor needs to be updated true is returned, otherwise false
  - update
```
public T update(boolean sign)
         throws SignatureException,
                MarshallingException
```
    Updates the encapsulated descriptor with a newly generated ID, a validity time according to this object's configuration, and then optionally signs the record.
    
    Specified by:
    
    update in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Parameters:
    
    sign - flag that should be set if the metadata is to be signed
    
    Returns:
    
    a reference to the resulting descriptor object
    
    Throws:
    
    SignatureException - for signature errors
    
    MarshallingException - for marshalling errors
    
    See Also:
    
    MetadataContainer.sign()
  - sign
```
public T sign()
       throws SignatureException,
              MarshallingException
```
    Signs the encapsulated descriptor using the signature credentials configured for this object.
    
    Specified by:
    
    sign in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    a reference to the resulting descriptor object
    
    Throws:
    
    SignatureException - for signature errors
    
    MarshallingException - for marshalling errors
    
    See Also:
    
    MetadataContainer.update(boolean)
  - marshall
```
public Element marshall()
                 throws MarshallingException
```
    Marshals the encapsulated descriptor into its XML representation.
    
    Specified by:
    
    marshall in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    an XML element
    
    Throws:
    
    MarshallingException - for marshalling errors
  - getValidity
```
public Duration getValidity()
```
    Returns the duration of the validity that the encapsulated descriptor has.
    
    Specified by:
    
    getValidity in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    the validity time for the metadata
  - setValidity
```
public void setValidity(Duration validity)
```
    Assigns the duration of the validity that the encapsulated EntityDescriptor should have.
    The default value is DEFAULT_VALIDITY.
    
    Parameters:
    
    validity - the validity
  - getUpdateFactor
```
public float getUpdateFactor()
```
    Returns the factor (between 0 and 1) that is used to compute whether it is time to update the contained descriptor. The higher the factor, the more often the metadata is updated. The "is update required" computation is calculated as follows:
```
 if (expireInstant > now) {
   return <update-required>
 }
 else {
   return (updateFactor * getValidity()) > (expireInstant - now) ? <update-required> : <no-update-required>
 }
 
```
    The easiest way to get the meaning of the update factor is perhaps using words. Suppose the update factor is 0,5, then the meaning is: "update the metadata when less than 50% of its original validity time remains".
    Specified by:
    
    getUpdateFactor in interface MetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>
    
    Returns:
    
    the update factor
  - setUpdateFactor
```
public void setUpdateFactor(float updateFactor)
```
    Assigns the factor (between 0 and 1) that is used to compute whether it is time to update the contained descriptor.
    The default value is DEFAULT_UPDATE_FACTOR.
    
    Parameters:
    
    updateFactor - the update factor
    
    See Also:
    
    getUpdateFactor()
  - getIdSize
```
public int getIdSize()
```
    Returns the size of the ID attribute that is generated.
    
    Returns:
    
    the size
  - setIdSize
```
public void setIdSize(int idSize)
```
    Assigns the size of the ID attribute that is generated.
    The default value is DEFAULT_DESCRIPTOR_ID_SIZE.
    
    Parameters:
    
    idSize - the size
  - getID
```
protected abstract String getID(T descriptor)
```
    Returns the ID attribute of the supplied descriptor.
    
    Parameters:
    
    descriptor - the descriptor
    
    Returns:
    
    the ID attribute
  - assignID
```
protected abstract void assignID(T descriptor,
                                 String id)
```
    Assigns the supplied id to the ID attribute of the descriptor.
    
    Parameters:
    
    descriptor - the descriptor
    
    id - the ID attribute value
  - getLogString
```
protected abstract String getLogString(T descriptor)
```
    Returns a log string of the supplied descriptor.
    
    Parameters:
    
    descriptor - the descriptor
    
    Returns:
    
    the log string

Class AbstractMetadataContainer<T extends TimeBoundSAMLObject & SignableSAMLObject & CacheableSAMLObject>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_VALIDITY

DEFAULT_UPDATE_FACTOR

DEFAULT_DESCRIPTOR_ID_SIZE

descriptor

validity

updateFactor

idSize

signatureCredentials

Constructor Detail

AbstractMetadataContainer

Method Detail

getDescriptor

cloneDescriptor

updateRequired

update

sign

marshall

getValidity

setValidity

getUpdateFactor

setUpdateFactor

getIdSize

setIdSize

getID

assignID

getLogString