ExternalAuthToken (pki-javadoc)

java.lang.Object
- com.netscape.certsrv.authentication.ExternalAuthToken

All Implemented Interfaces:

IAuthToken
```
public class ExternalAuthToken
extends java.lang.Object
implements IAuthToken
```
Authentication token that wraps an externally authenticated principal to return.

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.catalina.realm.GenericPrincipal principal
- Fields inherited from interface com.netscape.certsrv.authentication.IAuthToken
  GROUP, GROUPS, TOKEN_AUTHENTICATED_CERT_SUBJECT, TOKEN_AUTHMGR_INST_NAME, TOKEN_AUTHTIME, TOKEN_CERT, TOKEN_CERT_EXTENSIONS, TOKEN_CERT_NOTAFTER, TOKEN_CERT_NOTBEFORE, TOKEN_CERT_SERIALNUM, TOKEN_CERT_SUBJECT, TOKEN_CERT_TO_REVOKE, TOKEN_SHARED_TOKEN_AUTHENTICATED_CERT_SUBJECT, UID, USER, USER_DN, USER_ID

Fields
Modifier and Type	Field and Description
`protected org.apache.catalina.realm.GenericPrincipal`	`principal`

Constructor Summary

Constructors
Constructor and Description

ExternalAuthToken(org.apache.catalina.realm.GenericPrincipal principal)

Constructors
Constructor and Description
`ExternalAuthToken(org.apache.catalina.realm.GenericPrincipal principal)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`get(java.lang.String k)` Gets an attribute value.
`java.util.Enumeration<java.lang.String>`	`getElements()` Returns an enumeration of the names of the attributes existing within this AttrSet.
`java.math.BigInteger[]`	`getInBigIntegerArray(java.lang.String k)` Retrieves the BigInteger array value for name.
`byte[]`	`getInByteArray(java.lang.String k)` Retrieves the byte array value for name.
`byte[][]`	`getInByteArrayArray(java.lang.String k)` Retrieves the byte[][] value for name.
`org.mozilla.jss.netscape.security.x509.X509CertImpl`	`getInCert(java.lang.String k)` Retrieves the X509CertImpl value for name.
`org.mozilla.jss.netscape.security.x509.CertificateExtensions`	`getInCertExts(java.lang.String k)` Retrieves the CertificateExtensions value for name.
`Certificates`	`getInCertificates(java.lang.String k)` Retrieves the Certificates value for name.
`java.util.Date`	`getInDate(java.lang.String k)` Retrieves the Date value for name.
`java.lang.Integer`	`getInInteger(java.lang.String k)` Retrieves the Integer value for name.
`java.lang.String`	`getInString(java.lang.String k)` Gets an attribute value.
`java.lang.String[]`	`getInStringArray(java.lang.String k)` Retrieves the String array value for name.
`java.security.Principal`	`getPrincipal()`
`boolean`	`set(java.lang.String k, java.math.BigInteger[] v)` Stores the BigInteger array with the associated key.
`boolean`	`set(java.lang.String k, byte[] v)` Stores the byte array with the associated key.
`boolean`	`set(java.lang.String k, byte[][] v)` Stores the byte[][] with the associated key.
`boolean`	`set(java.lang.String k, org.mozilla.jss.netscape.security.x509.CertificateExtensions v)` Stores the CertificateExtensions with the associated key.
`boolean`	`set(java.lang.String k, Certificates v)` Stores the Certificates with the associated key.
`boolean`	`set(java.lang.String k, java.util.Date v)` Stores the Date with the associated key.
`boolean`	`set(java.lang.String k, java.lang.Integer v)` Stores the Integer with the associated key.
`boolean`	`set(java.lang.String k, java.lang.String v)` Sets an attribute value within this AttrSet.
`boolean`	`set(java.lang.String k, java.lang.String[] v)` Stores the String array with the associated key.
`boolean`	`set(java.lang.String k, org.mozilla.jss.netscape.security.x509.X509CertImpl v)` Stores the X509CertImpl with the associated key.

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

- Field Detail
  - principal
```
protected org.apache.catalina.realm.GenericPrincipal principal
```
- Constructor Detail
  - ExternalAuthToken
```
public ExternalAuthToken(org.apache.catalina.realm.GenericPrincipal principal)
```
- Method Detail
  - getPrincipal
```
public java.security.Principal getPrincipal()
```
  - getElements
```
public java.util.Enumeration<java.lang.String> getElements()
```
    Description copied from interface: IAuthToken
    
    Returns an enumeration of the names of the attributes existing within this AttrSet.
    
    Specified by:
    
    getElements in interface IAuthToken
    
    Returns:
    
    an enumeration of the attribute names.
  - get
```
public java.lang.Object get(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Gets an attribute value.
    
    Specified by:
    
    get in interface IAuthToken
    
    Parameters:
    
    k - the name of the attribute to return.
    
    Returns:
    
    the attribute value
  - set
```
public boolean set(java.lang.String k,
                   java.lang.String v)
```
    Description copied from interface: IAuthToken
    
    Sets an attribute value within this AttrSet.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - the name of the attribute
    
    v - the attribute object.
    
    Returns:
    
    false on an error
  - getInString
```
public java.lang.String getInString(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Gets an attribute value.
    
    Specified by:
    
    getInString in interface IAuthToken
    
    Parameters:
    
    k - the name of the attribute to return.
    
    Returns:
    
    the attribute value
  - set
```
public boolean set(java.lang.String k,
                   byte[] v)
```
    Description copied from interface: IAuthToken
    
    Stores the byte array with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on an error
  - getInByteArray
```
public byte[] getInByteArray(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the byte array value for name. The value should have been previously stored as a byte array (it will be CMS.AtoB decoded).
    
    Specified by:
    
    getInByteArray in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The byte array or null on error.
  - set
```
public boolean set(java.lang.String k,
                   java.lang.Integer v)
```
    Description copied from interface: IAuthToken
    
    Stores the Integer with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on an error
  - getInInteger
```
public java.lang.Integer getInInteger(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the Integer value for name.
    
    Specified by:
    
    getInInteger in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The Integer or null on error.
  - set
```
public boolean set(java.lang.String k,
                   java.math.BigInteger[] v)
```
    Description copied from interface: IAuthToken
    
    Stores the BigInteger array with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on an error
  - getInBigIntegerArray
```
public java.math.BigInteger[] getInBigIntegerArray(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the BigInteger array value for name.
    
    Specified by:
    
    getInBigIntegerArray in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value or null on error.
  - set
```
public boolean set(java.lang.String k,
                   java.util.Date v)
```
    Description copied from interface: IAuthToken
    
    Stores the Date with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on an error
  - getInDate
```
public java.util.Date getInDate(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the Date value for name.
    
    Specified by:
    
    getInDate in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value or null on error.
  - set
```
public boolean set(java.lang.String k,
                   java.lang.String[] v)
```
    Description copied from interface: IAuthToken
    
    Stores the String array with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    False on error.
  - getInStringArray
```
public java.lang.String[] getInStringArray(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the String array value for name.
    
    Specified by:
    
    getInStringArray in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value or null on error.
  - set
```
public boolean set(java.lang.String k,
                   org.mozilla.jss.netscape.security.x509.X509CertImpl v)
```
    Description copied from interface: IAuthToken
    
    Stores the X509CertImpl with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on error
  - getInCert
```
public org.mozilla.jss.netscape.security.x509.X509CertImpl getInCert(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the X509CertImpl value for name.
    
    Specified by:
    
    getInCert in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value or null on error.
  - set
```
public boolean set(java.lang.String k,
                   org.mozilla.jss.netscape.security.x509.CertificateExtensions v)
```
    Description copied from interface: IAuthToken
    
    Stores the CertificateExtensions with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on error
  - getInCertExts
```
public org.mozilla.jss.netscape.security.x509.CertificateExtensions getInCertExts(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the CertificateExtensions value for name.
    
    Specified by:
    
    getInCertExts in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value.
  - set
```
public boolean set(java.lang.String k,
                   Certificates v)
```
    Description copied from interface: IAuthToken
    
    Stores the Certificates with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on error
  - getInCertificates
```
public Certificates getInCertificates(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the Certificates value for name.
    
    Specified by:
    
    getInCertificates in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value.
  - set
```
public boolean set(java.lang.String k,
                   byte[][] v)
```
    Description copied from interface: IAuthToken
    
    Stores the byte[][] with the associated key.
    
    Specified by:
    
    set in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    v - The value to store
    
    Returns:
    
    false on error
  - getInByteArrayArray
```
public byte[][] getInByteArrayArray(java.lang.String k)
```
    Description copied from interface: IAuthToken
    
    Retrieves the byte[][] value for name.
    
    Specified by:
    
    getInByteArrayArray in interface IAuthToken
    
    Parameters:
    
    k - The attribute name.
    
    Returns:
    
    The value.

Class ExternalAuthToken

Field Summary

Fields inherited from interface com.netscape.certsrv.authentication.IAuthToken

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

principal

Constructor Detail

ExternalAuthToken

Method Detail

getPrincipal

getElements

get

set

getInString

set

getInByteArray

set

getInInteger

set

getInBigIntegerArray

set

getInDate

set

getInStringArray

set

getInCert

set

getInCertExts

set

getInCertificates

set

getInByteArrayArray