com.google.enterprise.adaptor.testing

Class UnsupportedAdaptorContext

java.lang.Object

com.google.enterprise.adaptor.testing.UnsupportedAdaptorContext

All Implemented Interfaces:

AdaptorContext

public class UnsupportedAdaptorContext
extends Object
implements AdaptorContext

An implementation of AdaptorContext that throws an UnsupportedOperationException if any method is called.

This class is intended to be extended for unit testing, rather than implementing the AdaptorContext interface directly.

Constructor Summary

Constructors

Constructor and Description
UnsupportedAdaptorContext()

Method Summary

Modifier and Type	Method and Description
void	addStatusSource(StatusSource source) Add a status source to the dashboard.
HttpContext	createHttpContext(String path, HttpHandler handler) Registers a handler with the library's HttpServer in similar fashion to HttpServer.createContext(java.lang.String, com.sun.net.httpserver.HttpHandler).
AsyncDocIdPusher	getAsyncDocIdPusher() Callback object for asynchronously pushing DocIds to the GSA at any time.
Config	getConfig() Configuration instance for the adaptor and all things within the adaptor library.
DocIdEncoder	getDocIdEncoder() A way to construct URIs from DocIds.
DocIdPusher	getDocIdPusher() Callback object for pushing DocIds to the GSA at any time.
ExceptionHandler	getGetDocIdsFullErrorHandler() Retrieve the current ExceptionHandler for full push.
ExceptionHandler	getGetDocIdsIncrementalErrorHandler() Retrieve the current ExceptionHandler for incremental push.
SensitiveValueDecoder	getSensitiveValueDecoder() Retrieve decoder for sensitive values, like passwords.
Session	getUserSession(HttpExchange ex, boolean create) Get the session for the user communicating via ex.
void	setAuthnAuthority(AuthnAuthority authnAuthority) Register an authentication provider, so it can authenticate users for the GSA.
void	setAuthzAuthority(AuthzAuthority authzAuthority) Register an authorization provider, so it can check authorization of users for the GSA.
void	setGetDocIdsFullErrorHandler(ExceptionHandler handler) Override the default ExceptionHandler for full push.
void	setGetDocIdsIncrementalErrorHandler(ExceptionHandler handler) Override the default ExceptionHandler for incremental push.
void	setPollingIncrementalLister(PollingIncrementalLister lister) Register a polling incremental lister, so that it can be called when appropriate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnsupportedAdaptorContext

public UnsupportedAdaptorContext()

Method Detail

getConfig

public Config getConfig()

Description copied from interface: AdaptorContext

Configuration instance for the adaptor and all things within the adaptor library.

Specified by:

getConfig in interface AdaptorContext

Returns:

Config of an instance

Throws:

UnsupportedOperationException - always

getDocIdPusher

public DocIdPusher getDocIdPusher()

Description copied from interface: AdaptorContext

Callback object for pushing DocIds to the GSA at any time.

Specified by:

getDocIdPusher in interface AdaptorContext

Returns:

DocIdPusher sends doc ids to GSA

Throws:

UnsupportedOperationException - always

getAsyncDocIdPusher

public AsyncDocIdPusher getAsyncDocIdPusher()

Description copied from interface: AdaptorContext

Callback object for asynchronously pushing DocIds to the GSA at any time.

Specified by:

getAsyncDocIdPusher in interface AdaptorContext

Returns:

AsyncDocIdPusher sends doc ids to GSA

Throws:

UnsupportedOperationException - always

getDocIdEncoder

public DocIdEncoder getDocIdEncoder()

Description copied from interface: AdaptorContext

A way to construct URIs from DocIds.

Specified by:

getDocIdEncoder in interface AdaptorContext

Returns:

DocIdEncoder makes URLs to this adaptor per doc id

Throws:

UnsupportedOperationException - always

addStatusSource

public void addStatusSource(StatusSource source)

Description copied from interface: AdaptorContext

Add a status source to the dashboard. The source will automatically be removed just before Adaptor.destroy(). Source registration should occur during Adaptor.init(com.google.enterprise.adaptor.AdaptorContext).

Specified by:

addStatusSource in interface AdaptorContext

Parameters:

source - gives data to dashboard

Throws:

UnsupportedOperationException - always

setGetDocIdsFullErrorHandler

public void setGetDocIdsFullErrorHandler(ExceptionHandler handler)

Description copied from interface: AdaptorContext

Override the default ExceptionHandler for full push.

Specified by:

setGetDocIdsFullErrorHandler in interface AdaptorContext

Parameters:

handler - for dealing with errors sending doc ids to GSA

Throws:

UnsupportedOperationException - always

getGetDocIdsFullErrorHandler

public ExceptionHandler getGetDocIdsFullErrorHandler()

Description copied from interface: AdaptorContext

Retrieve the current ExceptionHandler for full push.

Specified by:

getGetDocIdsFullErrorHandler in interface AdaptorContext

Returns:

ExceptionHandler deals with errors sending doc ids to GSA

Throws:

UnsupportedOperationException - always

setGetDocIdsIncrementalErrorHandler

public void setGetDocIdsIncrementalErrorHandler(ExceptionHandler handler)

Description copied from interface: AdaptorContext

Override the default ExceptionHandler for incremental push.

Specified by:

setGetDocIdsIncrementalErrorHandler in interface AdaptorContext

Parameters:

handler - for dealing with errors sending doc ids to GSA

Throws:

UnsupportedOperationException - always

getGetDocIdsIncrementalErrorHandler

public ExceptionHandler getGetDocIdsIncrementalErrorHandler()

Description copied from interface: AdaptorContext

Retrieve the current ExceptionHandler for incremental push.

Specified by:

getGetDocIdsIncrementalErrorHandler in interface AdaptorContext

Returns:

ExceptionHandler deals with errors sending doc ids to GSA

Throws:

UnsupportedOperationException - always

getSensitiveValueDecoder

public SensitiveValueDecoder getSensitiveValueDecoder()

Description copied from interface: AdaptorContext

Retrieve decoder for sensitive values, like passwords. To protect sensitive values, the user should have previously encoded them using the Dashboard. However, a user is still allowed to choose to keep sensitive values in plain text.

Specified by:

getSensitiveValueDecoder in interface AdaptorContext

Returns:

SensistiveValueDecoder to decode config values

Throws:

UnsupportedOperationException - always

createHttpContext

public HttpContext createHttpContext(String path,
                                     HttpHandler handler)

Description copied from interface: AdaptorContext

Registers a handler with the library's HttpServer in similar fashion to HttpServer.createContext(java.lang.String, com.sun.net.httpserver.HttpHandler). The handler will automatically be removed during adaptor shutdown. Handler registration should occur during Adaptor.init(com.google.enterprise.adaptor.AdaptorContext).

Although path may be passed directly to the underlying HttpServer, that is not necessarily the case. Thus, implementations should use the returned context's path when forming URLs to the handler. In addition, the handler and context may be modified before being returned; this is primarily to allow adding commonly-needed filters for error handling and logging, but also available for implementation-specific needs.

Specified by:

createHttpContext in interface AdaptorContext

Parameters:

path - on the server

handler - of requests for path

Returns:

HttpContext for path utility methods

Throws:

UnsupportedOperationException - always

getUserSession

public Session getUserSession(HttpExchange ex,
                              boolean create)

Description copied from interface: AdaptorContext

Get the session for the user communicating via ex. If a session does not already exist, then create determines if one should be created.

Specified by:

getUserSession in interface AdaptorContext

Parameters:

ex - exchange which user issued request

create - whether a new session should be created if one does not already exist for this user

Returns:

user's session, or null if session did not already exist and create = false

Throws:

UnsupportedOperationException - always

setPollingIncrementalLister

public void setPollingIncrementalLister(PollingIncrementalLister lister)

Description copied from interface: AdaptorContext

Register a polling incremental lister, so that it can be called when appropriate. Registration may not occur after Adaptor.init(com.google.enterprise.adaptor.AdaptorContext).

Specified by:

setPollingIncrementalLister in interface AdaptorContext

Parameters:

lister - provides updated ids

Throws:

UnsupportedOperationException - always

setAuthnAuthority

public void setAuthnAuthority(AuthnAuthority authnAuthority)

Description copied from interface: AdaptorContext

Register an authentication provider, so it can authenticate users for the GSA. Registration may not occur after Adaptor.init(com.google.enterprise.adaptor.AdaptorContext).

Specified by:

setAuthnAuthority in interface AdaptorContext

Parameters:

authnAuthority - identifies users

Throws:

UnsupportedOperationException - always

setAuthzAuthority

public void setAuthzAuthority(AuthzAuthority authzAuthority)

Description copied from interface: AdaptorContext

Register an authorization provider, so it can check authorization of users for the GSA. Registration may not occur after Adaptor.init(com.google.enterprise.adaptor.AdaptorContext).

Specified by:

setAuthzAuthority in interface AdaptorContext

Parameters:

authzAuthority - makes access decisions

Throws:

UnsupportedOperationException - always