com.sage.orion.sdata.servlet.accpac
Class ASWhoAmI

java.lang.Object
  com.sage.orion.sdata.servlet.accpac.ASWhoAmI

All Implemented Interfaces:

ResourceKind

public final class ASWhoAmI
extends java.lang.Object
implements ResourceKind

The ASWhoAmI class implements the ResourceKind interface to provide the SData resource asWhoAmI.

This resource is used mainly for testing, but should not do any harm in a normal production environment. It is included outside one of the testing packages because of the structure of the current code base. Note that it is explicitly constructed from the SystemResourceKind, with an abnormal context. That means it must be visible. That would require either that the 'src' source tree could see the 'test' source tree or else that a member of a 'testing' package be present in the 'src' source tree either of which would be very confusing. Once the construction of system resources is also data-driven we should revisit that decision and move this class. FIXME - Move this class to a testing package in the 'test' source tree once it can be instantiated normally.

Constructor Summary

ASWhoAmI(ApplicationContext applicationContext, ResourceContext context)
constructs an instance of the ASWhoAmI class, connecting it to the given contexts

Method Summary

java.lang.String	getInstance()
java.lang.String	getName()
ResourceResponse	handleRequest(SDataRequest request, AsyncStatusListener listener) Handle the specified request, passing information to the listener if there is one.
void	shutdown() Shut down the resource kind.

Methods inherited from class java.lang.Object

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

Constructor Detail

ASWhoAmI

public ASWhoAmI(ApplicationContext applicationContext,
                ResourceContext context)

constructs an instance of the ASWhoAmI class, connecting it to the given contexts

Parameters:

applicationContext - the ApplicationContext to which to connect the instance.

context - the ResourceContext to which to connect the instance.

Method Detail

handleRequest

public ResourceResponse handleRequest(SDataRequest request,
                                      AsyncStatusListener listener)

Description copied from interface: ResourceKind

Handle the specified request, passing information to the listener if there is one.

Note that even if an implementation is not thread-safe it must allow for the ResourceKind.shutdown() call to execute in parallel.

Specified by:

handleRequest in interface ResourceKind

Parameters:

request - the request to handle

listener - null or a listener than can be used for asynchronous tasks to monitor progress.

Returns:

a ResourceResponse to the request

shutdown

public void shutdown()

Description copied from interface: ResourceKind

Shut down the resource kind. Note that this may be called on a shutdown thread even though a different thread is executing ResourceKind.handleRequest(SDataRequest, AsyncStatusListener).

Specified by:

shutdown in interface ResourceKind

getInstance

public java.lang.String getInstance()

Specified by:

getInstance in interface ResourceKind

getName

public java.lang.String getName()

Specified by:

getName in interface ResourceKind