com.google.enterprise.connector.spi

Class Principal

java.lang.Object

com.google.enterprise.connector.spi.Principal

All Implemented Interfaces:

java.lang.Comparable<Principal>

public class Principal
extends java.lang.Object
implements java.lang.Comparable<Principal>

Represents a principal for authentication and authorization purposes.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
Principal(SpiConstants.PrincipalType principalType, java.lang.String namespace, java.lang.String name) Builds a case-sensitive Principal instance.
Principal(SpiConstants.PrincipalType principalType, java.lang.String namespace, java.lang.String name, SpiConstants.CaseSensitivityType caseSensitivityType) Builds a Principal instance.
Principal(java.lang.String name) Builds a Principal instance with simply a case-sensitive name.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Principal other) Note that this comparison is inconsistent with equals, in that the PrincipalType is not considered in ordering.
boolean	equals(java.lang.Object obj)
SpiConstants.CaseSensitivityType	getCaseSensitivityType() Gets how cases are handled for the principal.
java.lang.String	getName() Gets the principal name.
java.lang.String	getNamespace() Gets the principal namespace.
SpiConstants.PrincipalType	getPrincipalType() Gets the principal type.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Principal

public Principal(java.lang.String name)

Builds a Principal instance with simply a case-sensitive name.

Parameters:

name - the name of the principal

Principal

public Principal(SpiConstants.PrincipalType principalType,
                 java.lang.String namespace,
                 java.lang.String name)

Builds a case-sensitive Principal instance.

Parameters:

principalType - the principal type for the principal

namespace - the namespace for the principal

name - the name of the principal

Principal

public Principal(SpiConstants.PrincipalType principalType,
                 java.lang.String namespace,
                 java.lang.String name,
                 SpiConstants.CaseSensitivityType caseSensitivityType)

Builds a Principal instance.

Parameters:

principalType - the principal type

namespace - the namespace for the principal

name - the name of the principal

caseSensitivityType - how to handle casing for the principal

Method Detail

getName

public java.lang.String getName()

Gets the principal name.

Returns:

the principal name

getNamespace

public java.lang.String getNamespace()

Gets the principal namespace.

Returns:

the principal namespace

getPrincipalType

public SpiConstants.PrincipalType getPrincipalType()

Gets the principal type.

Returns:

the principal type

getCaseSensitivityType

public SpiConstants.CaseSensitivityType getCaseSensitivityType()

Gets how cases are handled for the principal.

Returns:

the case sensitivity type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

compareTo

public int compareTo(Principal other)

Note that this comparison is inconsistent with equals, in that the PrincipalType is not considered in ordering.

Specified by:

compareTo in interface java.lang.Comparable<Principal>