com.google.enterprise.connector.spi

Class AuthorizationResponse

java.lang.Object

com.google.enterprise.connector.spi.AuthorizationResponse

All Implemented Interfaces:

java.lang.Comparable<AuthorizationResponse>

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

The carrier type of the list returned by the AuthorizationManager.authorizeDocids method.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationResponse.Status Authorization Status codes.

Constructor Summary

Constructors

Constructor and Description
AuthorizationResponse(AuthorizationResponse.Status status, java.lang.String docid) Makes an AuthorizationResponse.
AuthorizationResponse(boolean valid, java.lang.String docid) Makes an AuthorizationResponse.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AuthorizationResponse other) Comparable for testing.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.lang.String	getDocid() Gets the docid.
AuthorizationResponse.Status	getStatus() Gets the status.
int	hashCode() Returns a hash code value for the object.
boolean	isValid() Tests whether authorization was valid (permitted).
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthorizationResponse

public AuthorizationResponse(boolean valid,
                             java.lang.String docid)

Makes an AuthorizationResponse. If valid is true, then status is set to PERMIT. If valid is false, status is set to DENY.

Parameters:

valid - indicates that authorization was successful (valid)

docid - the docid for which authorization succeeded - should not be null or empty

AuthorizationResponse

public AuthorizationResponse(AuthorizationResponse.Status status,
                             java.lang.String docid)

Makes an AuthorizationResponse.

Parameters:

status - the Status of this response

docid - The docid for which authorization succeeded - should not be null or empty

Since:

2.4

Method Detail

isValid

public boolean isValid()

Tests whether authorization was valid (permitted).

Returns:

true if status is PERMIT, false otherwise

getDocid

public java.lang.String getDocid()

Gets the docid.

Returns:

docid - should not be null or empty

getStatus

public AuthorizationResponse.Status getStatus()

Gets the status.

Returns:

status the Status

Since:

2.4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one. Implemented by running equals on the docid string and comparing the status.

Overrides:

equals in class java.lang.Object

Returns:

true if this object is the same as the obj argument; false otherwise

compareTo

public int compareTo(AuthorizationResponse other)

Comparable for testing.

Specified by:

compareTo in interface java.lang.Comparable<AuthorizationResponse>