org.apache.directory.shared.kerberos.components

Class PrincipalName

java.lang.Object

org.apache.directory.shared.kerberos.components.PrincipalName

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object

public class PrincipalName
extends java.lang.Object
implements org.apache.directory.api.asn1.Asn1Object

A principal Name, composed of a type and N names.

 PrincipalName   ::= SEQUENCE {
        name-type       [0] Int32,
        name-string     [1] SEQUENCE OF KerberosString
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG The logger
private java.util.List<byte[]>	nameBytes The principal name as a byte[], for encoding purpose
private java.util.List<java.lang.String>	nameString The principal name - we may have more than one -
private PrincipalNameType	nameType The type for this principal
private int	principalNameSeqLength
private int	principalStringsSeqLength
private int	principalStringsTagLength
private int	principalTypeLength
private int	principalTypeTagLength
private java.lang.String	realm The realm part

Constructor Summary

Constructors

Constructor and Description
PrincipalName() Creates a new empty instance of PrincipalName.
PrincipalName(javax.security.auth.kerberos.KerberosPrincipal principal) Creates a new instance of PrincipalName, given a KerberosPrincipal.
PrincipalName(java.lang.String[] nameParts, int nameType) Creates a new instance of PrincipalName given a String[] and an principal type.
PrincipalName(java.lang.String nameString, int nameType) Creates a new instance of PrincipalName.
PrincipalName(java.lang.String nameString, PrincipalNameType nameType) Creates a new instance of PrincipalName given a String and an principal type.

Method Summary

Modifier and Type	Method and Description
void	addName(java.lang.String name) Add a new name to the PrincipalName
int	computeLength() Compute the PrincipalName length
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the PrincipalName message to a PDU.
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getNames() Returns the name components.
java.lang.String	getNameString()
PrincipalNameType	getNameType() Returns the type of the PrincipalName.
java.lang.String	getRealm() Get the realm for the principal
int	hashCode()
void	setNameType(int nameType) Set the Principal name Type
void	setNameType(PrincipalNameType nameType) Set the Principal name Type
void	setRealm(java.lang.String realm) Set the realm for the principal
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

nameType

private PrincipalNameType nameType

The type for this principal

nameString

private java.util.List<java.lang.String> nameString

The principal name - we may have more than one -

realm

private java.lang.String realm

The realm part

nameBytes

private java.util.List<byte[]> nameBytes

The principal name as a byte[], for encoding purpose

principalNameSeqLength

private int principalNameSeqLength

principalTypeTagLength

private int principalTypeTagLength

principalTypeLength

private int principalTypeLength

principalStringsTagLength

private int principalStringsTagLength

principalStringsSeqLength

private int principalStringsSeqLength

Constructor Detail

PrincipalName

public PrincipalName()

Creates a new empty instance of PrincipalName.

PrincipalName

public PrincipalName(javax.security.auth.kerberos.KerberosPrincipal principal)

Creates a new instance of PrincipalName, given a KerberosPrincipal. We assume that a principal has only one type, even if there are more than one name component.

Parameters:

principal - A Sun kerberosPrincipal instance

PrincipalName

public PrincipalName(java.lang.String nameString,
                     PrincipalNameType nameType)
              throws java.text.ParseException

Creates a new instance of PrincipalName given a String and an principal type.

Parameters:

nameString - The name string, which can contains more than one nameComponent

nameType - The principal name

Throws:

java.text.ParseException

PrincipalName

public PrincipalName(java.lang.String[] nameParts,
                     int nameType)

Creates a new instance of PrincipalName given a String[] and an principal type.

Parameters:

nameParts - The name string, which can contains more than one nameComponent

nameType - The principal name type

PrincipalName

public PrincipalName(java.lang.String nameString,
                     int nameType)

Creates a new instance of PrincipalName.

Parameters:

nameString -

nameType -

Method Detail

getNameType

public PrincipalNameType getNameType()

Returns the type of the PrincipalName.

Returns:

The type of the PrincipalName.

setNameType

public void setNameType(PrincipalNameType nameType)

Set the Principal name Type

Parameters:

nameType - the Principal name Type

setNameType

public void setNameType(int nameType)

Set the Principal name Type

Parameters:

nameType - the Principal name Type

setRealm

public void setRealm(java.lang.String realm)

Set the realm for the principal

Parameters:

realm - the realm of the principal

getRealm

public java.lang.String getRealm()

Get the realm for the principal

Returns:

realm the realm of the principal

getNames

public java.util.List<java.lang.String> getNames()

Returns the name components.

Returns:

The name components.

getNameString

public java.lang.String getNameString()

Returns:

A String representing the principal names as a String

addName

public void addName(java.lang.String name)

Add a new name to the PrincipalName

Parameters:

name - The name to add

computeLength

public int computeLength()

Compute the PrincipalName length

 PrincipalName :
 
 0x30 L1 PrincipalName sequence
  |
  +--> 0xA1 L2 name-type tag
  |     |
  |     +--> 0x02 L2-1 addressType (int)
  |
  +--> 0xA2 L3 name-string tag
        |
        +--> 0x30 L3-1 name-string (SEQUENCE OF KerberosString)
              |
              +--> 0x1B L4[1] value (KerberosString)
              |
              +--> 0x1B L4[2] value (KerberosString)
              |
              ...
              |
              +--> 0x1B L4[n] value (KerberosString)
 

Specified by:

computeLength in interface org.apache.directory.api.asn1.Asn1Object

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.api.asn1.EncoderException

Encode the PrincipalName message to a PDU.

 PrincipalName :
 
 0x30 LL
   0xA0 LL 
     0x02 0x01 name-type (integer)
   0xA1 LL 
     0x30 LL name-string (SEQUENCE OF KerberosString)
       0x1B LL name-string[1]
       0x1B LL name-string[2]
       ...
       0x1B LL name-string[n]
 

Specified by:

encode in interface org.apache.directory.api.asn1.Asn1Object

Parameters:

buffer - The buffer where to put the PDU. It should have been allocated before, with the right size.

Returns:

The constructed PDU.

Throws:

org.apache.directory.api.asn1.EncoderException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object