A C E G I L N O P R S U V W

A

AbstractPlugins - Class in org.gatein.wsrp.api.plugins

Provides base behavior for server-specific Plugins implementations.

AbstractPlugins() - Constructor for class org.gatein.wsrp.api.plugins.AbstractPlugins

addRequestExtension(Class, Object) - Method in interface org.gatein.wsrp.api.extensions.ConsumerExtensionAccessor

Adds an extension before it is sent to the producer to elements of the specified target class.

addRequestExtension(Class, UnmarshalledExtension) - Method in interface org.gatein.wsrp.api.extensions.ProducerExtensionAccessor

Adds the specified unmarshalled extension to the list of extensions associated with instances the specified WSRP request class before the request is processed by the producer's portlet container.

addResponseExtension(Class, UnmarshalledExtension) - Method in interface org.gatein.wsrp.api.extensions.ConsumerExtensionAccessor

Adds the specified unmarshalled extension to be linked to the specified WSRP response class.

addResponseExtension(Class, Object) - Method in interface org.gatein.wsrp.api.extensions.ProducerExtensionAccessor

Add the specified extension to be set to the targeted WSRP response class before it is sent to the consumer.

assignPortletToWindow(PortletContext, String, String, String) - Method in interface org.gatein.wsrp.api.context.ConsumerStructureProvider

Re-assigns the window identified by the specified window identifier in the specified page to display the portlet identified by the specified portlet context, potentially using the specified title.

C

clear() - Method in interface org.gatein.wsrp.api.extensions.ConsumerExtensionAccessor

Clears the currently held extensions.

clear() - Method in interface org.gatein.wsrp.api.extensions.ProducerExtensionAccessor

Clears the currently held extensions.

CONSUMER_DELEGATE_CLASSNAME - Static variable in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

consumerDelegate() - Static method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Retrieves the delegate on the Consumer side.

ConsumerExtensionAccessor - Interface in org.gatein.wsrp.api.extensions

Accessor for consumer-side extensions.

ConsumerStructureProvider - Interface in org.gatein.wsrp.api.context

Provides a way to interact with the structure of the portal in which the WSRP consumer is running.

createPluginInstance(String, Class<T>) - Method in class org.gatein.wsrp.api.plugins.AbstractPlugins

createPluginInstance(String, Class<T>) - Method in interface org.gatein.wsrp.api.plugins.Plugins

Instantiates a plugin implementation using the default constructor of the plugin identified by the specified fully qualified class name, specifying that the implementation must implement the specified plugin interface.

E

ExtensionAccess - Class in org.gatein.wsrp.api.extensions

Provides an entry point to the extension support in GateIn WSRP.

ExtensionAccess() - Constructor for class org.gatein.wsrp.api.extensions.ExtensionAccess

G

getConsumerExtensionAccessor() - Static method in class org.gatein.wsrp.api.extensions.ExtensionAccess

getImplementationNamed(String, Class<T>) - Method in class org.gatein.wsrp.api.plugins.AbstractPlugins

Retrieves the Class object corresponding to the implementation named as specified by the provided name of the specified plugin interface.

getImplementationNamesFor(String, String) - Method in class org.gatein.wsrp.api.plugins.AbstractPlugins

Retrieves a list of fully qualified names of detected implementations of the WSRP extension interface specified by its provided fully qualified name, providing a default implementation class name.

getKnownPluginInterfaceNames() - Method in class org.gatein.wsrp.api.plugins.AbstractPlugins

getKnownPluginInterfaceNames() - Method in interface org.gatein.wsrp.api.plugins.Plugins

Retrieves the list of currently known extension points as plugins in our WSRP implementations.

getName() - Method in class org.gatein.wsrp.api.extensions.UnmarshalledExtension

getNamespaceURI() - Method in class org.gatein.wsrp.api.extensions.UnmarshalledExtension

getPageIdentifiers() - Method in interface org.gatein.wsrp.api.context.ConsumerStructureProvider

Retrieves the list of page identifiers.

getPluginImplementationNames(Class, String) - Method in class org.gatein.wsrp.api.plugins.AbstractPlugins

getPluginImplementationNames(Class, String) - Method in interface org.gatein.wsrp.api.plugins.Plugins

Retrieves a list of fully qualified names of detected implementations of the specified WSRP extension interface, providing a default implementation class name.

getPlugins() - Static method in class org.gatein.wsrp.api.plugins.PluginsAccess

getProducerExtensionAccessor() - Static method in class org.gatein.wsrp.api.extensions.ExtensionAccess

getRequest() - Static method in class org.gatein.wsrp.api.servlet.ServletAccess

getRequestExtensionsFor(Class) - Method in interface org.gatein.wsrp.api.extensions.ConsumerExtensionAccessor

Retrieves previously set extensions targeted at the specified WSRP 2 target class so that the consumer can add them to the requests before sending them to the producer.

getRequestExtensionsFor(Class) - Method in interface org.gatein.wsrp.api.extensions.ProducerExtensionAccessor

Retrieves the list of unmarshalled extensions currently associated with instances of the specified target consumer request class.

getResponse() - Static method in class org.gatein.wsrp.api.servlet.ServletAccess

getResponseExtensionsFor(Class) - Method in interface org.gatein.wsrp.api.extensions.ProducerExtensionAccessor

Retrieves the extensions associated with the specified WSRP response class so that they can be set appropriately on the response sent to the consumer.

getResponseExtensionsFrom(Class) - Method in interface org.gatein.wsrp.api.extensions.ConsumerExtensionAccessor

Retrieves extensions that were sent by the producer for instances of the specified response class.

getSession() - Method in interface org.gatein.wsrp.api.session.SessionEvent

Retrieves the HttpSession that triggered this event.

getSupportedLocales() - Method in interface org.gatein.wsrp.api.context.ProducerContext

Retrieves the list of locales supported by the environment in which the producer is running.

getType() - Method in interface org.gatein.wsrp.api.session.SessionEvent

Retrieves the type of this event.

getValue() - Method in class org.gatein.wsrp.api.extensions.UnmarshalledExtension

getWindowIdentifiersFor(String) - Method in interface org.gatein.wsrp.api.context.ConsumerStructureProvider

Retrieves the list of identifiers for the windows that are contained within the page identified by the specified identifier.

I

InvocationHandlerDelegate - Class in org.gatein.wsrp.api.extensions

A delegate that can be used to intercept PortletInvocations and PortletInvocationReponses before they are processed either by the Consumer or Producer.

InvocationHandlerDelegate() - Constructor for class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

invoke(Object, Method, Object[]) - Method in class org.gatein.wsrp.api.servlet.ServletAccess

isElement() - Method in class org.gatein.wsrp.api.extensions.UnmarshalledExtension

L

local - Static variable in class org.gatein.wsrp.api.servlet.ServletAccess

N

next - Variable in class org.gatein.wsrp.api.servlet.ServletAccess

NO_OP_BROADCASTER - Static variable in interface org.gatein.wsrp.api.session.SessionEventBroadcaster

notifyListenersOf(SessionEvent) - Method in interface org.gatein.wsrp.api.session.SessionEventBroadcaster

notifyListenersOf(SessionEvent) - Method in class org.gatein.wsrp.api.session.SessionEventBroadcaster.NullSessionEventBroadcaster

O

onSessionEvent(SessionEvent) - Method in interface org.gatein.wsrp.api.session.SessionEventListener

Reacts to the specified SessionEvent.

org.gatein.wsrp.api.context - package org.gatein.wsrp.api.context

org.gatein.wsrp.api.extensions - package org.gatein.wsrp.api.extensions

org.gatein.wsrp.api.plugins - package org.gatein.wsrp.api.plugins

org.gatein.wsrp.api.servlet - package org.gatein.wsrp.api.servlet

org.gatein.wsrp.api.session - package org.gatein.wsrp.api.session

P

Plugins - Interface in org.gatein.wsrp.api.plugins

An entry point for the WSRP plugins system with the underlying server.

PluginsAccess - Class in org.gatein.wsrp.api.plugins

Provides client code with a way to retrieve the current Plugins instance and the server implementation to register its Plugins implementation.

processInvocation(PortletInvocation) - Method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Method to process the specified PortletInvocation before it is handled by the rest of the WSRP invocation chain.

processInvocationResponse(PortletInvocationResponse, PortletInvocation) - Method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Method to process the specified PortletInvocationResponse before it is handled by the rest of the WSRP invocation chain.

PRODUCER_DELEGATE_CLASSNAME - Static variable in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

ProducerContext - Interface in org.gatein.wsrp.api.context

Provides an interface to pass information about the context in which the producer is running.

producerDelegate() - Static method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Retrieves the delegate on the Producer side.

ProducerExtensionAccessor - Interface in org.gatein.wsrp.api.extensions

Manages access to extensions on the producer-side so that API clients can set and retrieve extensions before requests are processed or responses sent back to the consumer.

R

register(Plugins) - Static method in class org.gatein.wsrp.api.plugins.PluginsAccess

registerConsumerAccessorInstance(ConsumerExtensionAccessor) - Static method in class org.gatein.wsrp.api.extensions.ExtensionAccess

registerConsumerDelegate(InvocationHandlerDelegate) - Static method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Only public for testing purposes

registerListener(String, SessionEventListener) - Method in class org.gatein.wsrp.api.session.SessionEventBroadcaster.NullSessionEventBroadcaster

registerListener(String, SessionEventListener) - Method in interface org.gatein.wsrp.api.session.SessionEventBroadcaster

registerProducerAccessorInstance(ProducerExtensionAccessor) - Static method in class org.gatein.wsrp.api.extensions.ExtensionAccess

registerProducerDelegate(InvocationHandlerDelegate) - Static method in class org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

Only public for testing purposes

S

ServletAccess - Class in org.gatein.wsrp.api.servlet

Provides WSRP-wide, thread-safe access to the current (if any) HttpServletRequest and HttpServletResponse for the current user operation.

ServletAccess() - Constructor for class org.gatein.wsrp.api.servlet.ServletAccess

SessionEvent - Interface in org.gatein.wsrp.api.session

An HTTP session event.

SessionEvent.SessionEventType - Enum in org.gatein.wsrp.api.session

What type of event is it?

SessionEventBroadcaster - Interface in org.gatein.wsrp.api.session

Broadcasts session events to registered listeners, so that the running environment only needs to provide an implementation of this interface so that WSRP components interested in session events can register with it instead of having to know about the running environment.

SessionEventBroadcaster.NullSessionEventBroadcaster - Class in org.gatein.wsrp.api.session

A default implementation of SessionEventBroadcaster that does nothing, in case we're not interested in SessionEvents.

SessionEventBroadcaster.NullSessionEventBroadcaster() - Constructor for class org.gatein.wsrp.api.session.SessionEventBroadcaster.NullSessionEventBroadcaster

SessionEventListener - Interface in org.gatein.wsrp.api.session

Listener interface for WSRP components interested in session events.

setRequestAndResponse(HttpServletRequest, HttpServletResponse) - Static method in class org.gatein.wsrp.api.servlet.ServletAccess

U

UnmarshalledExtension - Class in org.gatein.wsrp.api.extensions

An extension value, unmarshalled from a SOAP message.

UnmarshalledExtension(String, Object, String) - Constructor for class org.gatein.wsrp.api.extensions.UnmarshalledExtension

unregisterListener(String) - Method in class org.gatein.wsrp.api.session.SessionEventBroadcaster.NullSessionEventBroadcaster

unregisterListener(String) - Method in interface org.gatein.wsrp.api.session.SessionEventBroadcaster

V

valueOf(String) - Static method in enum org.gatein.wsrp.api.session.SessionEvent.SessionEventType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.gatein.wsrp.api.session.SessionEvent.SessionEventType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WSRP_PLUGIN_EXTENSION_SUFFIX - Static variable in interface org.gatein.wsrp.api.plugins.Plugins

The extension that identifies WSRP plugins.

A C E G I L N O P R S U V W