com.google.enterprise.connector.spi

Class AuthenticationResponse

java.lang.Object

com.google.enterprise.connector.spi.AuthenticationResponse

public class AuthenticationResponse
extends java.lang.Object

The response from the AuthenticationManager.authenticate method.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
AuthenticationResponse(boolean valid, java.lang.String data) Makes an AuthenticationResponse.
AuthenticationResponse(boolean valid, java.lang.String data, java.util.Collection<?> groups) Makes an AuthenticationResponse.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getData() Get the client data.
java.util.Collection<?>	getGroups() Gets the groups to which the user belongs.
boolean	isValid() Tests whether authentication was valid.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationResponse

public AuthenticationResponse(boolean valid,
                              java.lang.String data)

Makes an AuthenticationResponse.

Parameters:

valid - indicates that authentication was successful (valid)

data - Reserved for future use. May be set but will be ignored.

AuthenticationResponse

public AuthenticationResponse(boolean valid,
                              java.lang.String data,
                              java.util.Collection<?> groups)

Makes an AuthenticationResponse. The supplied Collection of groups may be either:

• Collection<String> for a simple collection of group names
• Collection<Principal> for groups with namespaces

Parameters:

valid - indicates that authentication was successful (valid)

data - Reserved for future use. May be set but will be ignored.

groups - a Collection of groups to which the user belongs

Since:

2.6.10

Method Detail

isValid

public boolean isValid()

Tests whether authentication was valid.

Returns:

true if authentication was valid

getData

public java.lang.String getData()

Get the client data.

Returns:

data - may be null

getGroups

public java.util.Collection<?> getGroups()

Gets the groups to which the user belongs. The returned Collection of groups is either:

• Collection<String> for a simple collection of group names
• Collection<Principal> for groups with namespaces

Returns:

Collection of group names - may be null

Since:

2.6.10

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object