ArchiveCutoff ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- iaik.x509.V3Extension
- - iaik.x509.ocsp.extensions.ArchiveCutoff

```
public class ArchiveCutoff
extends V3Extension
```
This class implements the OCSP ArchiveCutoff extension.
As with all OCSP extensions, support of the ArchiveCutoff extension is optional for client and servers. The critical flag should not be set.
Each OCSP extension is associated with a specific ocsp extension object identifier, derived from RFC 2560:
```
 id-pkix  OBJECT IDENTIFIER  ::=
        { iso(1) identified-organization(3) dod(6) internet(1)
          security(5) mechanisms(5) pkix(7) }

 id-ad OBJECT IDENTIFIER ::= { id-pkix 48 }       
        -- arc for access descriptors

 id-ad-ocsp      OBJECT IDENTIFIER ::= { id-ad 1 }
 
 id-pkix-ocsp    OBJECT IDENTIFIER ::= { id-ad-ocsp }
 
```
The object identifier for the ArchiveCutoff extension is defined as:
```
 id-pkix-ocsp-id-pkix-ocsp-archive-cutoff  OBJECT IDENTIFIER ::= { id-pkix-ocsp 6 }
 
```
which corresponds to the OID string "1.3.6.1.5.5.7.48.1.6".
The Online Certificate Status Protocol (RFC 2560) specifies the ArchiveCutoff extension for allowing a responder to choose to retain revocation information beyond a certificate's expiration. The date obtained by subtracting this retention interval value from the producedAt time in a response is defined as the certificate's "archive cutoff" date. OCSP-enabled applications would use an OCSP archive cutoff date to contribute to a proof that a digital signature was (or was not) reliable on the date it was produced even if the certificate needed to validate the signature has long since expired.
OCSP servers that provide support for such historical reference SHOULD include an archive cutoff date extension in responses. If included, this value SHALL be provided as an OCSP singleExtensions extension in the corresponding SingleResponse. If, for instance, a server is operated with a 7-year retention interval policy and status was produced at time t1 then the value for ArchiveCutoff in the response would be (t1 - 7 years).
ASN.1 definition:
```
 ArchiveCutoff ::= GeneralizedTime
 
```
For adding a ArchiveCutoff extension object to a SingleResponse, use the addExtension method, e.g.:
```
 Date cutoffTime = ...;
 ArchiveCutoff archiveCutoff = new ArchiveCutoff(cutoffTime);
 singleResponse.addExtension(ArchiveCutoff);
 
```
See Also:

SingleResponse, V3Extension, X509Extensions

Field Summary

Fields
Modifier and Type Field and Description

static ObjectID oid
The object identifier of this ArchiveCutoff extension.
- Fields inherited from class iaik.x509.V3Extension
  critical

Fields
Modifier and Type	Field and Description
`static ObjectID`	`oid` The object identifier of this ArchiveCutoff extension.

Constructor Summary

Constructors
Constructor and Description

ArchiveCutoff()
Default constructor.

ArchiveCutoff(java.util.Date cutoffTime)
Creates an ArchiveCutoff object from the given cuttoffTime.

Constructors
Constructor and Description
`ArchiveCutoff()` Default constructor.
`ArchiveCutoff(java.util.Date cutoffTime)` Creates an `ArchiveCutoff` object from the given cuttoffTime.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Date`	`getCutoffTime()` Gets the archive cutoff time.
`ObjectID`	`getObjectID()` Returns the object ID of this `ArchiveCutoff` extension
`int`	`hashCode()` Returns a hashcode for this identity.
`void`	`init(ASN1Object obj)` Inits this `ArchiveCutoff` implementation with an ASN1Object representing the value of this extension.
`void`	`setCutoffTime(java.util.Date cutoffTime)` Sets the cutoff time.
`ASN1Object`	`toASN1Object()` Returns an ASN1Object representing the value of this `ArchiveCutoff` extension.
`java.lang.String`	`toString()` Returns a string that represents the contents of this `ArchiveCutoff` extension.

Methods inherited from class iaik.x509.V3Extension
getName, isCritical, setCritical

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

- Field Detail
  - oid
```
public static final ObjectID oid
```
    The object identifier of this ArchiveCutoff extension. The corresponding OID string is "1.3.6.1.5.5.7.48.1.6".
- Constructor Detail
  - ArchiveCutoff
```
public ArchiveCutoff()
```
    Default constructor. Creates an empty ArchiveCutoff object. Use methods setCutoffTime for setting the cutoff time of this ArchiveCutoff extension.
  - ArchiveCutoff
```
public ArchiveCutoff(java.util.Date cutoffTime)
```
    Creates an ArchiveCutoff object from the given cuttoffTime.
    
    Parameters:
    
    cutoffTime - the date of the beginning of the retention interval
- Method Detail
  - setCutoffTime
```
public void setCutoffTime(java.util.Date cutoffTime)
```
    Sets the cutoff time.
    
    Parameters:
    
    cutoffTime - the date of the beginning of the retention interval
  - getCutoffTime
```
public java.util.Date getCutoffTime()
```
    Gets the archive cutoff time.
    
    Returns:
    
    the date of the beginning of the retention interval
  - getObjectID
```
public ObjectID getObjectID()
```
    Returns the object ID of this ArchiveCutoff extension
    
    Specified by:
    
    getObjectID in class V3Extension
    
    Returns:
    
    the object ID
  - init
```
public void init(ASN1Object obj)
          throws X509ExtensionException
```
    Inits this ArchiveCutoff implementation with an ASN1Object representing the value of this extension.
    The given ASN1Object is the one created by toASN1Object().
    This method is used by the X509Extensions class when parsing the ASN.1 representation of a OCSP object for properly initializing an included ArchiveCutoff extension. This method initializes the extension only with its value, but not with its critical specification. For that reason, this method shall not be explicitly called by an application.
    The ASN1Object supplied to this method will reflect the ASN.1 representation of the ArchiveCutoff extension value:
```
 ArchiveCutoff ::= GeneralizedTime
 
```
    Specified by:
    
    init in class V3Extension
    
    Parameters:
    
    obj - the ArchiveCutoff as ASN1Object (GeneralizedTime)
    
    Throws:
    
    X509ExtensionException - if the extension cannot be initialized from its ASN1 representation
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Returns an ASN1Object representing the value of this ArchiveCutoff extension.
    The ASN1Object returned by this method will reflect the ASN.1 representation of the ArchiveCutoff extension value:
```
 ArchiveCutoff ::= GeneralizedTime
 
```
    Specified by:
    
    toASN1Object in class V3Extension
    
    Returns:
    
    the value of this ArchiveCutoff as ASN1Object (GenerailzedTime)
  - hashCode
```
public int hashCode()
```
    Returns a hashcode for this identity.
    
    Specified by:
    
    hashCode in class V3Extension
    
    Returns:
    
    a hash code for this identity
  - toString
```
public java.lang.String toString()
```
    Returns a string that represents the contents of this ArchiveCutoff extension.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation

Class ArchiveCutoff

Field Summary

Fields inherited from class iaik.x509.V3Extension

Constructor Summary

Method Summary

Methods inherited from class iaik.x509.V3Extension

Methods inherited from class java.lang.Object

Field Detail

oid

Constructor Detail

ArchiveCutoff

ArchiveCutoff

Method Detail

setCutoffTime

getCutoffTime

getObjectID

init

toASN1Object

hashCode

toString