A C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractSessionAttributeResolver - Class in org.gatein.pc.api.invocation.resolver
- AbstractSessionAttributeResolver(HttpServletRequest) - Constructor for class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- AccessMode - Enum in org.gatein.pc.api.state
-
Type safe enumeration for the access mode to a portlet.
- ACTION - org.gatein.pc.api.LifeCyclePhase
- ActionInvocation - Class in org.gatein.pc.api.invocation
- ActionInvocation(PortletInvocationContext) - Constructor for class org.gatein.pc.api.invocation.ActionInvocation
- ActionURL - Interface in org.gatein.pc.api
- ADMIN - Static variable in class org.gatein.pc.api.Mode
-
.
- append(ResponseProperties) - Method in class org.gatein.pc.api.invocation.response.ResponseProperties
- AttributeResolver<K,V> - Interface in org.gatein.pc.api.invocation.resolver
-
An attribute resolver.
- attributes - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
.
C
- CacheControl - Class in org.gatein.pc.api.cache
- CacheControl(int, CacheScope, String) - Constructor for class org.gatein.pc.api.cache.CacheControl
- CacheInfo - Interface in org.gatein.pc.api.info
- CacheLevel - Class in org.gatein.pc.api.cache
- CacheScope - Enum in org.gatein.pc.api.cache
- call(ServletContext, HttpServletRequest, HttpServletResponse) - Method in interface org.gatein.pc.api.spi.ServerContext.Callable
-
The callback
- CapabilitiesInfo - Interface in org.gatein.pc.api.info
-
Gathers capability information (portlet modes, window states, supported media types and locales) regarding a portlet.
- clear() - Method in class org.gatein.pc.api.invocation.response.ResponseProperties
- clear() - Method in class org.gatein.pc.api.ParametersStateString
-
Clear all the parameters.
- clientContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The client context.
- ClientContext - Interface in org.gatein.pc.api.spi
- CLONE_BEFORE_WRITE - org.gatein.pc.api.state.AccessMode
-
Clone before write access mode.
- CONFIDENTIAL - org.gatein.pc.api.TransportGuarantee
- CONSUMER_CLONE_DUMMY_STATE_ID - Static variable in class org.gatein.pc.api.PortletContext
- CONSUMER_CLONE_ID - Static variable in class org.gatein.pc.api.PortletContext
- CONSUMER_CLONE_ID_PREFIX - Static variable in class org.gatein.pc.api.PortletContext
- CONSUMER_CLONE_PREFIX_LENGTH - Static variable in class org.gatein.pc.api.PortletContext
- ContainerURL - Interface in org.gatein.pc.api
- containsTransportGuarantee(TransportGuarantee) - Method in interface org.gatein.pc.api.info.SecurityInfo
- ContentResponse - Class in org.gatein.pc.api.invocation.response
-
Data produced.
- ContentResponse(ContentResponse, CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.ContentResponse
- ContentResponse(ResponseProperties, Map<String, Object>, String, String, byte[], CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.ContentResponse
- ContentResponse(ResponseProperties, Map<String, Object>, String, String, String, CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.ContentResponse
- ContentResponse(ResponseProperties, Map<String, Object>, String, CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.ContentResponse
- create() - Static method in class org.gatein.pc.api.ParametersStateString
- create(DataInputStream) - Static method in class org.gatein.pc.api.StateString
-
Factory method that will create the most appropriate form from the byte representation.
- create(String) - Static method in class org.gatein.pc.api.cache.CacheLevel
- create(String) - Static method in class org.gatein.pc.api.Mode
- create(String) - Static method in class org.gatein.pc.api.StateString
-
Factory method that will create the most appropriate form from the string representation.
- create(String) - Static method in class org.gatein.pc.api.WindowState
- create(String, boolean) - Static method in class org.gatein.pc.api.Mode
- create(String, boolean) - Static method in class org.gatein.pc.api.WindowState
- create(String, PortletStateType<S>, S) - Static method in class org.gatein.pc.api.StatefulPortletContext
- create(String, StatefulPortletContext<S>) - Static method in class org.gatein.pc.api.StatefulPortletContext
- create(Map<String, String[]>) - Static method in class org.gatein.pc.api.ParametersStateString
- create(StateString) - Static method in class org.gatein.pc.api.ParametersStateString
-
Create a parameters state string.
- createClone(PortletStateType, PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Clone a portlet.
- createCopyWithInvoker(String) - Method in interface org.gatein.pc.api.PortletContext.Components
- createCopyWithoutInvoker() - Method in interface org.gatein.pc.api.PortletContext.Components
- createMap(String) - Method in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- createPortletContext(String) - Static method in class org.gatein.pc.api.PortletContext
-
Creates a PortletContext by interpreting the specified identifier and breaking it down to its components.
- createPortletContext(String, boolean) - Static method in class org.gatein.pc.api.PortletContext
- createPortletContext(String, byte[]) - Static method in class org.gatein.pc.api.PortletContext
-
Deprecated.
- createPortletContext(String, byte[], boolean) - Static method in class org.gatein.pc.api.PortletContext
- createPortletContext(String, String) - Static method in class org.gatein.pc.api.PortletContext
-
Creates a new PortletContext referencing the specified portlet in the specified application (usually a web application).
- createStatefulPortletContext(String, byte[]) - Static method in class org.gatein.pc.api.PortletContext
-
Deprecated.
- ctx - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The invocation context.
D
- decodeOpaqueValue(String) - Static method in class org.gatein.pc.api.StateString
- dereference(PortletContext) - Static method in class org.gatein.pc.api.PortletContext
- DESCRIPTION - Static variable in interface org.gatein.pc.api.info.MetaInfo
-
Key for description.
- DestroyCloneFailure - Class in org.gatein.pc.api.state
- DestroyCloneFailure(String) - Constructor for class org.gatein.pc.api.state.DestroyCloneFailure
- DestroyCloneFailure(String, String) - Constructor for class org.gatein.pc.api.state.DestroyCloneFailure
- destroyClones(List<PortletContext>) - Method in interface org.gatein.pc.api.PortletInvoker
-
Destroy a cloned portlet.
- dispatch(ServletContext, HttpServletRequest, HttpServletResponse, ServerContext.Callable) - Method in interface org.gatein.pc.api.spi.ServerContext
-
Delegate to the request context the dispatching to the target servlet context using the specified spi elements.
- DISPLAY_NAME - Static variable in interface org.gatein.pc.api.info.MetaInfo
-
Key for display name.
E
- EDIT - Static variable in class org.gatein.pc.api.Mode
-
.
- EDIT_DEFAULTS - Static variable in class org.gatein.pc.api.Mode
-
.
- EMPTY - Static variable in class org.gatein.pc.api.StateString
- encodeAsOpaqueValue(Map<String, String[]>) - Static method in class org.gatein.pc.api.StateString
- encodeResourceURL(String) - Method in interface org.gatein.pc.api.spi.PortletInvocationContext
-
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
- equals(Object) - Method in class org.gatein.pc.api.cache.CacheLevel
- equals(Object) - Method in class org.gatein.pc.api.Mode
- equals(Object) - Method in class org.gatein.pc.api.OpaqueStateString
- equals(Object) - Method in class org.gatein.pc.api.ParametersStateString
- equals(Object) - Method in class org.gatein.pc.api.PortletContext
- equals(Object) - Method in class org.gatein.pc.api.state.DestroyCloneFailure
- equals(Object) - Method in class org.gatein.pc.api.StatefulPortletContext
- equals(Object) - Method in class org.gatein.pc.api.WindowState
- equals(S, S) - Method in class org.gatein.pc.api.PortletStateType
- ErrorResponse - Class in org.gatein.pc.api.invocation.response
-
Application level error.
- ErrorResponse(String) - Constructor for class org.gatein.pc.api.invocation.response.ErrorResponse
- ErrorResponse(String, Throwable) - Constructor for class org.gatein.pc.api.invocation.response.ErrorResponse
- ErrorResponse(Throwable) - Constructor for class org.gatein.pc.api.invocation.response.ErrorResponse
- Event(QName, Serializable) - Constructor for class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse.Event
- EVENT - org.gatein.pc.api.LifeCyclePhase
- EventInfo - Interface in org.gatein.pc.api.info
- EventingInfo - Interface in org.gatein.pc.api.info
- EventInvocation - Class in org.gatein.pc.api.invocation
- EventInvocation(PortletInvocationContext) - Constructor for class org.gatein.pc.api.invocation.EventInvocation
- exportPortlet(PortletStateType, PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Exports a portlet from the invoker which can be used to recreate this portlet during an import portlet operation The returned portlet Id will be the portlet Id of the base portlet, not a cloned portlet Id If the portlet contains state, it will be returned regardless if the portlet invoker is set to persist state locally.
F
- form - Variable in class org.gatein.pc.api.invocation.ActionInvocation
-
.
- FragmentResponse - Class in org.gatein.pc.api.invocation.response
-
Data produced.
- FragmentResponse(FragmentResponse, CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.FragmentResponse
- FragmentResponse(ResponseProperties, Map<String, Object>, String, String, byte[], String, CacheControl, Set<Mode>) - Constructor for class org.gatein.pc.api.invocation.response.FragmentResponse
- FragmentResponse(ResponseProperties, Map<String, Object>, String, String, String, String, CacheControl, Set<Mode>) - Constructor for class org.gatein.pc.api.invocation.response.FragmentResponse
- FragmentResponse(ResponseProperties, Map<String, Object>, String, String, CacheControl, Set<Mode>) - Constructor for class org.gatein.pc.api.invocation.response.FragmentResponse
- FULL - Static variable in class org.gatein.pc.api.cache.CacheLevel
G
- getAccessMode() - Method in interface org.gatein.pc.api.spi.InstanceContext
-
Return the access mode to this portlet instance.
- getAliases() - Method in interface org.gatein.pc.api.info.EventInfo
- getAliases() - Method in interface org.gatein.pc.api.info.ParameterInfo
- getAllLocales() - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves all the locales supported by the associated Portlet.
- getAllModes() - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves all the portlet modes supported by the associated Portlet.
- getAllWindowStates() - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves all the window states supported by the associated Portlet.
- getApplicationName() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Returns the portlet application name.
- getApplicationName() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- getAttachment(Class<T>) - Method in interface org.gatein.pc.api.info.PortletInfo
-
Returns a generic attachment on the portlet info.
- getAttribute(Object) - Method in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- getAttribute(Object) - Method in class org.gatein.pc.api.invocation.resolver.MapAttributeResolver
- getAttribute(String) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getAttribute(String) - Method in interface org.gatein.pc.api.spi.UserContext
-
Returns an attribute related to the user identity.
- getAttribute(K) - Method in interface org.gatein.pc.api.invocation.resolver.AttributeResolver
-
Return an attribute from this resolver.
- getAttributes() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
- getAttributes() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getAuthType() - Method in interface org.gatein.pc.api.spi.SecurityContext
- getBytes() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
-
Return the bytes of the content held by the fragment.
- getBytes() - Method in class org.gatein.pc.api.invocation.response.StreamResponse
- getCache() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves caching-related information for the described portlet.
- getCacheability() - Method in interface org.gatein.pc.api.ResourceURL
-
Returns the resource cacheability.
- getCacheControl() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
- getCacheControl() - Method in class org.gatein.pc.api.invocation.response.RevalidateMarkupResponse
- getCacheLevel() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getCacheScope() - Method in class org.gatein.pc.api.cache.CacheControl
- getCapabilities() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves the capabilities of supported by the described portlet.
- getCause() - Method in class org.gatein.pc.api.invocation.response.ErrorResponse
-
The throwable.
- getCharacterEncoding() - Method in interface org.gatein.pc.api.spi.RequestContext
-
Returns the name of the character encoding used in the body of this request.
- getChars() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
-
Return the chars of the content held by the fragment.
- getClientContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getComponents() - Method in class org.gatein.pc.api.PortletContext
- getConsumedEvents() - Method in interface org.gatein.pc.api.info.EventingInfo
- getContent() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
-
Return the content as a string, when the character encoding is set, it will be used for binary content, otherwise the
UTF-8will be used. - getContent(Charset) - Method in class org.gatein.pc.api.invocation.response.ContentResponse
-
Return the content as a string, the provided charset will be used for binary content.
- getContentLength() - Method in interface org.gatein.pc.api.spi.RequestContext
-
Returns the length, in bytes, of the request body which is made available by the input stream, or -1 if the length is not known.
- getContentType() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
-
Return the content type of the generated fragment.
- getContentType() - Method in class org.gatein.pc.api.invocation.response.StreamResponse
- getContentType() - Method in interface org.gatein.pc.api.spi.RequestContext
-
Returns the MIME type of the body of the request, or null if the type is not known.
- getContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getContext() - Method in interface org.gatein.pc.api.Portlet
-
Return the portlet context.
- getCookies() - Method in class org.gatein.pc.api.invocation.response.ResponseProperties
- getCookies() - Method in interface org.gatein.pc.api.spi.ClientContext
- getDefaultValue() - Method in interface org.gatein.pc.api.info.PreferenceInfo
-
Return the default value or null if it cannot be determined (for instance WSRP v1 does not define it).
- getDescription() - Method in interface org.gatein.pc.api.info.EventInfo
- getDescription() - Method in interface org.gatein.pc.api.info.ModeInfo
-
The mode description.
- getDescription() - Method in interface org.gatein.pc.api.info.ParameterInfo
- getDescription() - Method in interface org.gatein.pc.api.info.PreferenceInfo
-
Retrieves the localized description of the described preference.
- getDescription() - Method in interface org.gatein.pc.api.info.WindowStateInfo
-
The window state description.
- getDispatchedRequest() - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Deprecated.
- getDispatchedResponse() - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Deprecated.
- getDisplayName() - Method in interface org.gatein.pc.api.info.EventInfo
- getDisplayName() - Method in interface org.gatein.pc.api.info.PortletManagedModeInfo
-
Returns the display name of the mode.
- getDisplayName() - Method in interface org.gatein.pc.api.info.PreferenceInfo
-
Retrieves the localized display name of the described preference.
- getEncoding() - Method in class org.gatein.pc.api.invocation.RenderInvocation
- getEncoding() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
- getEventing() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Return the eventing information.
- getEvents() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getExpirationSecs() - Method in class org.gatein.pc.api.cache.CacheControl
- getExpirationSecs() - Method in interface org.gatein.pc.api.info.CacheInfo
-
The expiration in seconds.
- getForm() - Method in class org.gatein.pc.api.invocation.ActionInvocation
- getForm() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getId() - Method in interface org.gatein.pc.api.info.ParameterInfo
- getId() - Method in class org.gatein.pc.api.PortletContext
- getId() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- getId() - Method in interface org.gatein.pc.api.spi.InstanceContext
-
Return an id that can differenciate instances.
- getId() - Method in interface org.gatein.pc.api.spi.UserContext
-
Retrieves the user id or null if it is not known.
- getId() - Method in interface org.gatein.pc.api.spi.WindowContext
-
Return an id that can differenciate windows.
- getInfo() - Method in interface org.gatein.pc.api.Portlet
-
Return the portlet info.
- getInfo() - Method in interface org.gatein.pc.api.spi.PortalContext
-
Return info about the portal.
- getInformations() - Method in interface org.gatein.pc.api.spi.UserContext
-
The user profile information keyed by P3PConstants
- getInputStream() - Method in interface org.gatein.pc.api.spi.RequestContext
-
Retrieves the body of the HTTP request from client to portal as binary data using an
InputStream. - getInstanceContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getInteractionState() - Method in interface org.gatein.pc.api.ActionURL
-
Return the interaction state.
- getInteractionState() - Method in class org.gatein.pc.api.invocation.ActionInvocation
- getInvokerName() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- getJavaType() - Method in class org.gatein.pc.api.PortletStateType
- getKey() - Method in interface org.gatein.pc.api.info.PreferenceInfo
-
Retrieves the key associated to the described preference.
- getKey() - Method in class org.gatein.pc.api.state.PropertyChange
-
Return the property key
- getKeys() - Method in interface org.gatein.pc.api.info.PreferencesInfo
-
Return the immutable set of keys.
- getKeys() - Method in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- getKeys() - Method in interface org.gatein.pc.api.invocation.resolver.AttributeResolver
-
Returns the set of keys of the attributes bound in that resolver.
- getKeys() - Method in class org.gatein.pc.api.invocation.resolver.MapAttributeResolver
- getKeys() - Method in interface org.gatein.pc.api.state.PropertyContext
-
Return an immutable set of keys.
- getLocale() - Method in interface org.gatein.pc.api.spi.UserContext
-
Return the user locale.
- getLocales() - Method in interface org.gatein.pc.api.spi.UserContext
-
Retrieves the locales that the user is willing to receive information in.
- getLocales(MediaType) - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves the locales supported by the associated Portlet for the specified MIME type.
- getLocation() - Method in class org.gatein.pc.api.invocation.response.HTTPRedirectionResponse
- getMapKey() - Method in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- getMapKey() - Method in class org.gatein.pc.api.invocation.resolver.PrincipalAttributeResolver
- getMarkupHeaders() - Method in class org.gatein.pc.api.invocation.response.ResponseProperties
- getMediaTypes() - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves all the Media types supported by the associated Portlet.
- getMessage() - Method in class org.gatein.pc.api.invocation.response.ErrorResponse
-
The logged message.
- getMessage() - Method in class org.gatein.pc.api.state.DestroyCloneFailure
- getMeta() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves the portlet description (title, keywords, etc).
- getMetaValue(String) - Method in interface org.gatein.pc.api.info.MetaInfo
-
Return the meta value of the portlet for a specific key.
- getMethod() - Method in interface org.gatein.pc.api.spi.ClientContext
- getMode() - Method in interface org.gatein.pc.api.ContainerURL
-
Returns the mode that may be null.
- getMode() - Method in interface org.gatein.pc.api.info.ModeInfo
-
The mode value.
- getMode() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getMode() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getMode(Mode) - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Returns a mode info matching a specifed mode or null.
- getModeName() - Method in interface org.gatein.pc.api.info.ModeInfo
-
Retrieves the associated Mode name.
- getModes() - Method in interface org.gatein.pc.api.spi.PortalContext
-
Return the modes accepted by this portal context.
- getModes(MediaType) - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves the portlet modes supported by the associated Portlet for the specified Media type.
- getName() - Method in interface org.gatein.pc.api.info.EventInfo
- getName() - Method in interface org.gatein.pc.api.info.ParameterInfo
- getName() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Returns the portlet name.
- getName() - Method in interface org.gatein.pc.api.info.RuntimeOptionInfo
- getName() - Method in interface org.gatein.pc.api.info.TypeInfo
- getName() - Method in class org.gatein.pc.api.invocation.EventInvocation
- getName() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse.Event
- getName() - Method in class org.gatein.pc.api.state.Property
- getNamespace() - Method in interface org.gatein.pc.api.spi.WindowContext
-
Return a String that can be used for the Portlet prefixing of tokens that need to be unique within the markup of the aggregated page (e.g.
- getNavigation() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Returns the navigation information.
- getNavigationalState() - Method in interface org.gatein.pc.api.ContainerURL
-
Return the navigational state that may be null.
- getNavigationalState() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getNavigationalState() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getNextModes() - Method in class org.gatein.pc.api.invocation.response.FragmentResponse
-
Returns the next modes.
- getParameters() - Method in class org.gatein.pc.api.ParametersStateString
-
Return the underlying parameter object.
- getPayload() - Method in class org.gatein.pc.api.invocation.EventInvocation
- getPayload() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse.Event
- getPortalContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getPortlet(PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Get information about a specific portlet.
- getPortletContext() - Method in class org.gatein.pc.api.StateEvent
- getPortletId() - Method in exception org.gatein.pc.api.InvalidPortletIdException
- getPortletId() - Method in exception org.gatein.pc.api.PortletCloneFailedException
- getPortletId() - Method in class org.gatein.pc.api.state.DestroyCloneFailure
- getPortletName() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- getPortlets() - Method in interface org.gatein.pc.api.PortletInvoker
-
Return the set of portlet exposed.
- getPreference(String) - Method in interface org.gatein.pc.api.info.PreferencesInfo
-
A preference specified by its key.
- getPreferences() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves information about the preferences supported by the described portlet, it must return null if the portlet cannot be personalized.
- getProducedEvents() - Method in interface org.gatein.pc.api.info.EventingInfo
- getProperties() - Method in interface org.gatein.pc.api.ContainerURL
-
Returns a set of properties associated with this URL.
- getProperties() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
- getProperties() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getProperties() - Method in interface org.gatein.pc.api.spi.ClientContext
-
Returns the properties as seen by the client.
- getProperties() - Method in interface org.gatein.pc.api.spi.PortalContext
-
Return the set of properties of this portal context.
- getProperties(PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Return all the properties of the specified portlet.
- getProperties(PortletContext, Set<String>) - Method in interface org.gatein.pc.api.PortletInvoker
-
Return a subset of the properties of the specified portlet.
- getProperty(String) - Method in interface org.gatein.pc.api.state.PropertyMap
-
Return the value for the given key or null if it does not exist.
- getPublicNavigationalState() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getPublicNavigationalStateChanges() - Method in interface org.gatein.pc.api.RenderURL
-
Returns the public navigational state changes.
- getPublicNavigationalStateUpdates() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getPublicParameter(String) - Method in interface org.gatein.pc.api.info.NavigationInfo
-
Returns a public parameter by using its id or null if it does not exist.
- getPublicParameter(QName) - Method in interface org.gatein.pc.api.info.NavigationInfo
-
Returns a public parameter by using its name or null if it does not exist.
- getPublicParameters() - Method in interface org.gatein.pc.api.info.NavigationInfo
-
Returns the collection of known public parameters.
- getReader() - Method in interface org.gatein.pc.api.spi.RequestContext
-
Retrieves the body of the HTTP request from the client to the portal as character data using a
BufferedReader. - getRemoteUser() - Method in interface org.gatein.pc.api.spi.SecurityContext
- getRequest() - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Returns the http servlet request.
- getRequestAttributes() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getRequestContext() - Method in class org.gatein.pc.api.invocation.ActionInvocation
- getRequestContext() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getResourceId() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getResourceId() - Method in interface org.gatein.pc.api.ResourceURL
-
Returns the resource id
- getResourceState() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getResourceState() - Method in interface org.gatein.pc.api.ResourceURL
-
Returns the resource state.
- getResponse() - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Returns the http servlet request.
- getResponseContentType() - Method in interface org.gatein.pc.api.spi.PortletInvocationContext
-
Returns the response content type
- getRuntimeOptionsInfo() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves the runtime container options set by the associated portlet, if any.
- getScheme() - Method in interface org.gatein.pc.api.spi.ServerContext
-
Return the scheme value.
- getSecurity() - Method in interface org.gatein.pc.api.info.PortletInfo
-
Retrieves the security information for the described portlet.
- getSecurityContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getServerContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getServerName() - Method in interface org.gatein.pc.api.spi.ServerContext
-
Return the server name value.
- getServerPort() - Method in interface org.gatein.pc.api.spi.ServerContext
-
Return the server port value.
- getSize() - Method in class org.gatein.pc.api.ParametersStateString
-
Return the size.
- getState() - Method in class org.gatein.pc.api.StatefulPortletContext
- getStateId() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- getStateType() - Method in interface org.gatein.pc.api.spi.InstanceContext
-
Returns the state type managed by the consumer.
- getStatus(PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Returns the status of a specified
#PortletContextor null if the portlet context does not have a relationship with this portlet invoker. - getStringValue() - Method in class org.gatein.pc.api.OpaqueStateString
- getStringValue() - Method in class org.gatein.pc.api.ParametersStateString
-
Retrieves the opaque version associated with this navigational state.
- getStringValue() - Method in class org.gatein.pc.api.StateString
-
Return the value of the navigational state of the portlet.
- getTarget() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getThrowable() - Method in class org.gatein.pc.api.invocation.response.SecurityErrorResponse
- getTitle() - Method in class org.gatein.pc.api.invocation.response.FragmentResponse
-
Return the fragment title.
- getTransportGuarantees() - Method in interface org.gatein.pc.api.info.SecurityInfo
- getTransportHeaders() - Method in class org.gatein.pc.api.invocation.response.ResponseProperties
- getType() - Method in interface org.gatein.pc.api.info.EventInfo
-
Returns the type of the event or null if the event does not declare a type.
- getType() - Method in class org.gatein.pc.api.invocation.response.ContentResponse
- getType() - Method in class org.gatein.pc.api.state.PropertyChange
-
Return the property change type.
- getType() - Method in class org.gatein.pc.api.StateEvent
- getType() - Method in class org.gatein.pc.api.StatefulPortletContext
- getUnavailableSeconds() - Method in class org.gatein.pc.api.invocation.response.UnavailableResponse
- getUserContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getUserPrincipal() - Method in interface org.gatein.pc.api.spi.SecurityContext
- getValidationToken() - Method in class org.gatein.pc.api.cache.CacheControl
- getValidationToken() - Method in class org.gatein.pc.api.invocation.RenderInvocation
- getValidationToken() - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- getValue() - Method in class org.gatein.pc.api.state.Property
- getValue() - Method in class org.gatein.pc.api.state.PropertyChange
-
Return the new value or null in case of a property reset.
- getValue(String) - Method in class org.gatein.pc.api.ParametersStateString
-
Return the parameter value or null if it does not exist.
- getValue(String) - Method in interface org.gatein.pc.api.state.PropertyContext
-
Return for a specified key an immutable list of its values or null if the value does not exist.
- getValues() - Method in interface org.gatein.pc.api.info.RuntimeOptionInfo
- getValues(String) - Method in class org.gatein.pc.api.ParametersStateString
-
Return the parameter values or null if it does not exist.
- getWantAuthenticated() - Method in class org.gatein.pc.api.URLFormat
- getWantEscapeXML() - Method in class org.gatein.pc.api.URLFormat
- getWantRelative() - Method in class org.gatein.pc.api.URLFormat
- getWantSecure() - Method in class org.gatein.pc.api.URLFormat
- getWindowContext() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getWindowState() - Method in interface org.gatein.pc.api.ContainerURL
-
Returns the window state that may be null.
- getWindowState() - Method in interface org.gatein.pc.api.info.WindowStateInfo
-
The window state value.
- getWindowState() - Method in class org.gatein.pc.api.invocation.PortletInvocation
- getWindowState() - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- getWindowState(WindowState) - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Returns a window state info matching a specifed window state or null.
- getWindowStateName() - Method in interface org.gatein.pc.api.info.WindowStateInfo
-
Retrieves the associated window state name.
- getWindowStates() - Method in interface org.gatein.pc.api.spi.PortalContext
-
Return the window states accepted by this portal context.
- getWindowStates(MediaType) - Method in interface org.gatein.pc.api.info.CapabilitiesInfo
-
Retrieves the window states supported by the associated Portlet for the specified MIME type.
- getXMLBinding() - Method in interface org.gatein.pc.api.info.TypeInfo
H
- hashCode() - Method in class org.gatein.pc.api.cache.CacheLevel
- hashCode() - Method in class org.gatein.pc.api.Mode
- hashCode() - Method in class org.gatein.pc.api.OpaqueStateString
- hashCode() - Method in class org.gatein.pc.api.ParametersStateString
- hashCode() - Method in class org.gatein.pc.api.PortletContext
- hashCode() - Method in class org.gatein.pc.api.state.DestroyCloneFailure
- hashCode() - Method in class org.gatein.pc.api.StatefulPortletContext
- hashCode() - Method in class org.gatein.pc.api.WindowState
- hashCode(S) - Method in class org.gatein.pc.api.PortletStateType
- HELP - Static variable in class org.gatein.pc.api.Mode
-
.
- HTTPRedirectionResponse - Class in org.gatein.pc.api.invocation.response
-
Redirection to an HTTP location.
- HTTPRedirectionResponse(String) - Constructor for class org.gatein.pc.api.invocation.response.HTTPRedirectionResponse
I
- importPortlet(PortletStateType, PortletContext) - Method in interface org.gatein.pc.api.PortletInvoker
-
Imports a portlet into the invoker.
- instanceContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The instance context.
- InstanceContext - Interface in org.gatein.pc.api.spi
- InsufficientPrivilegesResponse - Class in org.gatein.pc.api.invocation.response
- InsufficientPrivilegesResponse() - Constructor for class org.gatein.pc.api.invocation.response.InsufficientPrivilegesResponse
- InsufficientTransportGuaranteeResponse - Class in org.gatein.pc.api.invocation.response
- InsufficientTransportGuaranteeResponse() - Constructor for class org.gatein.pc.api.invocation.response.InsufficientTransportGuaranteeResponse
- INTEGRAL - org.gatein.pc.api.TransportGuarantee
- interactionState - Variable in class org.gatein.pc.api.invocation.ActionInvocation
-
.
- interpret() - Method in class org.gatein.pc.api.PortletContext
- INVALID_PORTLET_CONTEXT - Static variable in class org.gatein.pc.api.PortletContext
- InvalidPortletIdException - Exception in org.gatein.pc.api
-
Thrown by the portlet invoker when a portlet id that is not valid.
- InvalidPortletIdException(String) - Constructor for exception org.gatein.pc.api.InvalidPortletIdException
- InvalidPortletIdException(String, String) - Constructor for exception org.gatein.pc.api.InvalidPortletIdException
- InvalidPortletIdException(String, Throwable, String) - Constructor for exception org.gatein.pc.api.InvalidPortletIdException
- InvalidPortletIdException(Throwable, String) - Constructor for exception org.gatein.pc.api.InvalidPortletIdException
- InvocationException - Exception in org.gatein.pc.api.invocation
- InvocationException() - Constructor for exception org.gatein.pc.api.invocation.InvocationException
- InvocationException(String) - Constructor for exception org.gatein.pc.api.invocation.InvocationException
- InvocationException(String, Throwable) - Constructor for exception org.gatein.pc.api.invocation.InvocationException
- InvocationException(Throwable) - Constructor for exception org.gatein.pc.api.invocation.InvocationException
- invoke(PortletInvocation) - Method in interface org.gatein.pc.api.PortletInvoker
-
Invoke an operation on a specific portlet.
- INVOKER_SEPARATOR - Static variable in class org.gatein.pc.api.PortletContext
-
The separator used in the id to route to the correct invoker.
- InvokerUnavailableException - Exception in org.gatein.pc.api
- InvokerUnavailableException() - Constructor for exception org.gatein.pc.api.InvokerUnavailableException
- InvokerUnavailableException(String) - Constructor for exception org.gatein.pc.api.InvokerUnavailableException
- InvokerUnavailableException(String, Throwable) - Constructor for exception org.gatein.pc.api.InvokerUnavailableException
- InvokerUnavailableException(Throwable) - Constructor for exception org.gatein.pc.api.InvokerUnavailableException
- isActive() - Method in interface org.gatein.pc.api.PortletInvoker
-
Returns whether this portlet invoker is active and can respond to requests.
- isAuthenticated() - Method in interface org.gatein.pc.api.spi.SecurityContext
- isCloned() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- isConsumerCloned() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- isInterpreted() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- isPermanent() - Method in class org.gatein.pc.api.invocation.response.UnavailableResponse
- isProducerCloned() - Method in interface org.gatein.pc.api.PortletContext.PortletContextComponents
- isReadOnly() - Method in interface org.gatein.pc.api.info.PreferenceInfo
-
Return true if the preference is read-only, false otherwise or null if it cannot be determined.
- isReadOnly() - Method in interface org.gatein.pc.api.state.PropertyContext
-
Return true if the preferences are globally read only.
- isRemote() - Method in interface org.gatein.pc.api.Portlet
-
Determines whether the described portlet is remote or not.
- isSecure() - Method in interface org.gatein.pc.api.spi.SecurityContext
- isUserInRole(String) - Method in interface org.gatein.pc.api.spi.SecurityContext
J
- JAVAX_PORTLET_ACTION_SCOPED_REQUEST_ATTRIBUTES - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
- JAVAX_PORTLET_ESCAPE_XML - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
- JAVAX_PORTLET_SERVLET_DEFAULT_SESSION_SCOPE - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
- JBPNS_PREFIX - Static variable in class org.gatein.pc.api.StateString
-
.
K
- KEYWORDS - Static variable in interface org.gatein.pc.api.info.MetaInfo
-
Key for locale specific keywords associated with this portlet.
L
- LifeCyclePhase - Enum in org.gatein.pc.api
-
Enumerate the life cycle phase of a Portlet.
- LOCAL_CONSUMER_CLONE - Static variable in class org.gatein.pc.api.PortletContext
- LOCAL_PORTLET_INVOKER_ID - Static variable in interface org.gatein.pc.api.PortletInvoker
-
The identifier assigned to the local PortletInvoker.
- location - Variable in class org.gatein.pc.api.invocation.response.HTTPRedirectionResponse
-
.
- logErrorTo(Logger, String) - Method in class org.gatein.pc.api.invocation.response.ErrorResponse
-
Logs an error message to the specified logger, using either the message or this ErrorResult's Throwable if available.
M
- MANAGED - org.gatein.pc.api.PortletStatus
-
A portlet is managed by the PortletInvoker when the invoker is able to perform any operation on it.
- MapAttributeResolver - Class in org.gatein.pc.api.invocation.resolver
- MapAttributeResolver() - Constructor for class org.gatein.pc.api.invocation.resolver.MapAttributeResolver
- MapAttributeResolver(Map) - Constructor for class org.gatein.pc.api.invocation.resolver.MapAttributeResolver
- MAXIMIZED - Static variable in class org.gatein.pc.api.WindowState
-
.
- MetaInfo - Interface in org.gatein.pc.api.info
-
Portlet metadata (display-name, title, short title, keywords).
- MINIMIZED - Static variable in class org.gatein.pc.api.WindowState
-
.
- mode - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
.
- Mode - Class in org.gatein.pc.api
- Mode(String) - Constructor for class org.gatein.pc.api.Mode
-
This NEEDS to be public for JAXB unmarshalling done by SupportsMetaData.
- ModeInfo - Interface in org.gatein.pc.api.info
N
- name - Variable in class org.gatein.pc.api.state.Property
-
The property name.
- name() - Method in class org.gatein.pc.api.cache.CacheLevel
- navigationalState - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
.
- NavigationInfo - Interface in org.gatein.pc.api.info
- newReset(String) - Static method in class org.gatein.pc.api.state.PropertyChange
-
Create a new property reset.
- newUpdate(String, String) - Static method in class org.gatein.pc.api.state.PropertyChange
-
Create a new property update, the list of values will be clone for safety.
- newUpdate(String, String[]) - Static method in class org.gatein.pc.api.state.PropertyChange
-
Create a new property update, the list of values will be clone for safety.
- newUpdate(String, List<String>) - Static method in class org.gatein.pc.api.state.PropertyChange
-
Create a new property update, the list of values will be clone for safety.
- NONE - org.gatein.pc.api.TransportGuarantee
- NORMAL - Static variable in class org.gatein.pc.api.WindowState
-
.
- NoSuchPortletException - Exception in org.gatein.pc.api
-
Thrown by the portlet invoker when a portlet id does not exist.
- NoSuchPortletException(String) - Constructor for exception org.gatein.pc.api.NoSuchPortletException
- NoSuchPortletException(String, String) - Constructor for exception org.gatein.pc.api.NoSuchPortletException
- NoSuchPortletException(String, Throwable, String) - Constructor for exception org.gatein.pc.api.NoSuchPortletException
- NoSuchPortletException(Throwable, String) - Constructor for exception org.gatein.pc.api.NoSuchPortletException
- NUMBER_OF_CACHED_SCOPES - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
O
- OFFERED - org.gatein.pc.api.PortletStatus
-
A portlet part of the set of exposed portlets as returned by
PortletInvoker.getPortlets(). - onStateEvent(StateEvent) - Method in interface org.gatein.pc.api.spi.InstanceContext
-
A state event occured.
- OPAQUE - Static variable in class org.gatein.pc.api.PortletStateType
- OPAQUE - Static variable in class org.gatein.pc.api.StateString
- OpaqueStateString - Class in org.gatein.pc.api
-
An opaque implementation of the navigational state.
- OpaqueStateString(String) - Constructor for class org.gatein.pc.api.OpaqueStateString
- org.gatein.pc.api - package org.gatein.pc.api
- org.gatein.pc.api.cache - package org.gatein.pc.api.cache
- org.gatein.pc.api.info - package org.gatein.pc.api.info
- org.gatein.pc.api.invocation - package org.gatein.pc.api.invocation
- org.gatein.pc.api.invocation.resolver - package org.gatein.pc.api.invocation.resolver
- org.gatein.pc.api.invocation.response - package org.gatein.pc.api.invocation.response
- org.gatein.pc.api.spi - package org.gatein.pc.api.spi
- org.gatein.pc.api.state - package org.gatein.pc.api.state
P
- PAGE - Static variable in class org.gatein.pc.api.cache.CacheLevel
- ParameterInfo - Interface in org.gatein.pc.api.info
- ParametersStateString - Class in org.gatein.pc.api
-
A set of parameters.
- ParametersStateString() - Constructor for class org.gatein.pc.api.ParametersStateString
-
Creates an empty parameter set.
- ParametersStateString(DataInputStream) - Constructor for class org.gatein.pc.api.ParametersStateString
- ParametersStateString(String) - Constructor for class org.gatein.pc.api.ParametersStateString
- portalContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The portal context.
- PortalContext - Interface in org.gatein.pc.api.spi
-
Represent the context of the portal that performs the invocation.
- Portlet - Interface in org.gatein.pc.api
-
Defines a logical portlet.
- PORTLET - Static variable in class org.gatein.pc.api.cache.CacheLevel
- PORTLET_CLONED_EVENT - org.gatein.pc.api.StateEvent.Type
- PORTLET_MODIFIED_EVENT - org.gatein.pc.api.StateEvent.Type
- PortletCloneFailedException - Exception in org.gatein.pc.api
- PortletCloneFailedException(String) - Constructor for exception org.gatein.pc.api.PortletCloneFailedException
- PortletCloneFailedException(String, String) - Constructor for exception org.gatein.pc.api.PortletCloneFailedException
- PortletCloneFailedException(String, Throwable, String) - Constructor for exception org.gatein.pc.api.PortletCloneFailedException
- PortletCloneFailedException(Throwable, String) - Constructor for exception org.gatein.pc.api.PortletCloneFailedException
- PortletContext - Class in org.gatein.pc.api
- PortletContext(String) - Constructor for class org.gatein.pc.api.PortletContext
- PortletContext(String, boolean) - Constructor for class org.gatein.pc.api.PortletContext
- PortletContext(PortletContext.Components) - Constructor for class org.gatein.pc.api.PortletContext
- PortletContext.Components - Interface in org.gatein.pc.api
- PortletContext.PortletContextComponents - Interface in org.gatein.pc.api
- PortletInfo - Interface in org.gatein.pc.api.info
-
Runtime meta data for a portlet.
- PortletInvocation - Class in org.gatein.pc.api.invocation
- PortletInvocation(PortletInvocationContext) - Constructor for class org.gatein.pc.api.invocation.PortletInvocation
-
Create an invocation to a portlet.
- PortletInvocationContext - Interface in org.gatein.pc.api.spi
-
Contract that defines what input/services the caller of a portlet container must provide.
- PortletInvocationResponse - Class in org.gatein.pc.api.invocation.response
-
The base interface for all result objects.
- PortletInvocationResponse() - Constructor for class org.gatein.pc.api.invocation.response.PortletInvocationResponse
- PortletInvoker - Interface in org.gatein.pc.api
- PortletInvokerException - Exception in org.gatein.pc.api
- PortletInvokerException() - Constructor for exception org.gatein.pc.api.PortletInvokerException
- PortletInvokerException(String) - Constructor for exception org.gatein.pc.api.PortletInvokerException
- PortletInvokerException(String, Throwable) - Constructor for exception org.gatein.pc.api.PortletInvokerException
- PortletInvokerException(Throwable) - Constructor for exception org.gatein.pc.api.PortletInvokerException
- PortletManagedModeInfo - Interface in org.gatein.pc.api.info
-
Extends the mode info interface to add the notion of portlet managed mode.
- PortletStateType<S extends Serializable> - Class in org.gatein.pc.api
- PortletStateType() - Constructor for class org.gatein.pc.api.PortletStateType
- PortletStatus - Enum in org.gatein.pc.api
-
The status of the relationship of a portlet with an invoker.
- PortletURL - Interface in org.gatein.pc.api
- PREF_RESET - Static variable in class org.gatein.pc.api.state.PropertyChange
-
The change is a reset of the property value.
- PREF_UPDATE - Static variable in class org.gatein.pc.api.state.PropertyChange
-
The change is an update of the property value.
- PreferenceInfo - Interface in org.gatein.pc.api.info
-
Describes a Portlet preference.
- PREFERENCES_ATTRIBUTE - Static variable in interface org.gatein.pc.api.state.PropertyContext
-
The attribute name under which the preferences can be accessed.
- PreferencesInfo - Interface in org.gatein.pc.api.info
- PrincipalAttributeResolver - Class in org.gatein.pc.api.invocation.resolver
- PrincipalAttributeResolver(HttpServletRequest) - Constructor for class org.gatein.pc.api.invocation.resolver.PrincipalAttributeResolver
- PRIVATE - org.gatein.pc.api.cache.CacheScope
- PRODUCER_CLONE_ID_PREFIX - Static variable in class org.gatein.pc.api.PortletContext
- PRODUCER_CLONE_PREFIX_LENGTH - Static variable in class org.gatein.pc.api.PortletContext
- Property - Class in org.gatein.pc.api.state
- Property(String, List<String>) - Constructor for class org.gatein.pc.api.state.Property
- PropertyChange - Class in org.gatein.pc.api.state
-
A property change.
- PropertyContext - Interface in org.gatein.pc.api.state
-
Exposes to the portlet the interface to deal with the personalization state.
- PropertyMap - Interface in org.gatein.pc.api.state
- PUBLIC - org.gatein.pc.api.cache.CacheScope
- publicNavigationalState - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
.
- publicNavigationalStateUpdates - Variable in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
-
The update to the public parameters.
Q
- queueEvent(UpdateNavigationalStateResponse.Event) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
R
- READ_ONLY - org.gatein.pc.api.state.AccessMode
-
Read only access mode.
- READ_WRITE - org.gatein.pc.api.state.AccessMode
-
Read write access mode.
- RedirectionResponse - Class in org.gatein.pc.api.invocation.response
-
Redirection to something.
- RedirectionResponse() - Constructor for class org.gatein.pc.api.invocation.response.RedirectionResponse
- reference(String, PortletContext) - Static method in class org.gatein.pc.api.PortletContext
- REMOTABLE_RUNTIME_OPTION - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
- remove(String) - Method in class org.gatein.pc.api.ParametersStateString
-
Remove a parameter.
- removeAttribute(Object) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- RENDER - org.gatein.pc.api.LifeCyclePhase
- RenderInvocation - Class in org.gatein.pc.api.invocation
- RenderInvocation(PortletInvocationContext) - Constructor for class org.gatein.pc.api.invocation.RenderInvocation
- renderURL(Writer, ContainerURL, URLFormat) - Method in interface org.gatein.pc.api.spi.PortletInvocationContext
-
Renders a container URL.
- renderURL(ContainerURL, URLFormat) - Method in interface org.gatein.pc.api.spi.PortletInvocationContext
-
Renders a container URL.
- RenderURL - Interface in org.gatein.pc.api
- replace(Map<String, String[]>) - Method in class org.gatein.pc.api.ParametersStateString
-
Replace all the parameters.
- req - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The dispatched request.
- req - Variable in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
-
.
- requestAttributes - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The portlet request attributes.
- requestContext - Variable in class org.gatein.pc.api.invocation.ActionInvocation
-
The request context.
- RequestContext - Interface in org.gatein.pc.api.spi
- RESOURCE - org.gatein.pc.api.LifeCyclePhase
- ResourceInvocation - Class in org.gatein.pc.api.invocation
- ResourceInvocation(PortletInvocationContext) - Constructor for class org.gatein.pc.api.invocation.ResourceInvocation
- ResourceURL - Interface in org.gatein.pc.api
- resp - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The dispatched response.
- ResponseProperties - Class in org.gatein.pc.api.invocation.response
- ResponseProperties() - Constructor for class org.gatein.pc.api.invocation.response.ResponseProperties
- RevalidateMarkupResponse - Class in org.gatein.pc.api.invocation.response
- RevalidateMarkupResponse(CacheControl) - Constructor for class org.gatein.pc.api.invocation.response.RevalidateMarkupResponse
- RuntimeOptionInfo - Interface in org.gatein.pc.api.info
S
- securityContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The security context.
- SecurityContext - Interface in org.gatein.pc.api.spi
- SecurityErrorResponse - Class in org.gatein.pc.api.invocation.response
- SecurityErrorResponse(Throwable) - Constructor for class org.gatein.pc.api.invocation.response.SecurityErrorResponse
- SecurityInfo - Interface in org.gatein.pc.api.info
- SecurityResponse - Class in org.gatein.pc.api.invocation.response
- SecurityResponse() - Constructor for class org.gatein.pc.api.invocation.response.SecurityResponse
- SERIALIZED - Static variable in class org.gatein.pc.api.StateString
- serverContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The server context.
- ServerContext - Interface in org.gatein.pc.api.spi
-
Defines the request context contract.
- ServerContext.Callable - Interface in org.gatein.pc.api.spi
-
The dispatch callable contract.
- setAttribute(Object, Object) - Method in class org.gatein.pc.api.invocation.resolver.AbstractSessionAttributeResolver
- setAttribute(Object, Object) - Method in class org.gatein.pc.api.invocation.resolver.MapAttributeResolver
- setAttribute(String, Object) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setAttribute(String, Object) - Method in interface org.gatein.pc.api.spi.UserContext
-
Set an attribute related to the user identity.
- setAttribute(K, V) - Method in interface org.gatein.pc.api.invocation.resolver.AttributeResolver
-
Update an attribute value on this resolve.
- setAttributes(Map<String, Object>) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- setCacheLevel(CacheLevel) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setClientContext(ClientContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setDispatchedRequest(HttpServletRequest) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setDispatchedResponse(HttpServletResponse) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setEncoding(String) - Method in class org.gatein.pc.api.invocation.RenderInvocation
- setForm(Map<String, String[]>) - Method in class org.gatein.pc.api.invocation.ActionInvocation
- setForm(Map<String, String[]>) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setInstanceContext(InstanceContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setInteractionState(StateString) - Method in class org.gatein.pc.api.invocation.ActionInvocation
- setMode(Mode) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setMode(Mode) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- setName(QName) - Method in class org.gatein.pc.api.invocation.EventInvocation
- setNavigationalState(StateString) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setNavigationalState(StateString) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- setPayload(Serializable) - Method in class org.gatein.pc.api.invocation.EventInvocation
- setPortalContext(PortalContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setProperties(ResponseProperties) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- setProperties(PortletContext, PropertyChange[]) - Method in interface org.gatein.pc.api.PortletInvoker
-
Set the properties on the specified portlet.
- setProperty(String, List<String>) - Method in interface org.gatein.pc.api.state.PropertyMap
-
Update the value of the given key.
- setPublicNavigationalState(Map<String, String[]>) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setPublicNavigationalStateUpdates(Map<String, String[]>) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- setRequest(HttpServletRequest) - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Set the http servlet request.
- setRequestAttributes(Map<String, Object>) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setRequestContext(RequestContext) - Method in class org.gatein.pc.api.invocation.ActionInvocation
- setRequestContext(RequestContext) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setResourceId(String) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setResourceState(StateString) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setResponse(HttpServletResponse) - Method in class org.gatein.pc.api.invocation.PortletInvocation
-
Set the http servlet request.
- setSecurityContext(SecurityContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setServerContext(ServerContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setTarget(PortletContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setUserContext(UserContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setValidationToken(String) - Method in class org.gatein.pc.api.invocation.RenderInvocation
- setValidationToken(String) - Method in class org.gatein.pc.api.invocation.ResourceInvocation
- setValue(String, String) - Method in class org.gatein.pc.api.ParametersStateString
-
Set the a parameter value.
- setValues(String, String[]) - Method in class org.gatein.pc.api.ParametersStateString
-
Set the parameter values.
- setWindowContext(WindowContext) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setWindowState(WindowState) - Method in class org.gatein.pc.api.invocation.PortletInvocation
- setWindowState(WindowState) - Method in class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- SHORT_TITLE - Static variable in interface org.gatein.pc.api.info.MetaInfo
-
Key for short title.
- StateEvent - Class in org.gatein.pc.api
-
An event that signals state modifications
- StateEvent(PortletContext, StateEvent.Type) - Constructor for class org.gatein.pc.api.StateEvent
- StateEvent.Type - Enum in org.gatein.pc.api
- StatefulPortletContext<S extends Serializable> - Class in org.gatein.pc.api
- StateString - Class in org.gatein.pc.api
-
Encapsulate state as a string.
- StateString() - Constructor for class org.gatein.pc.api.StateString
- StreamResponse - Class in org.gatein.pc.api.invocation.response
-
Stream a result to the client directly.
- StreamResponse(String, byte[]) - Constructor for class org.gatein.pc.api.invocation.response.StreamResponse
- SUPPORTED_OPTIONS - Static variable in interface org.gatein.pc.api.info.RuntimeOptionInfo
T
- target - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The target portlet.
- TITLE - Static variable in interface org.gatein.pc.api.info.MetaInfo
-
Key for title.
- toHTML() - Method in class org.gatein.pc.api.invocation.response.ErrorResponse
-
Provides an HTML description of the error, using either the message or the encapsulated Throwable.
- toString() - Method in class org.gatein.pc.api.Mode
- toString() - Method in class org.gatein.pc.api.ParametersStateString
- toString() - Method in class org.gatein.pc.api.PortletContext
- toString() - Method in enum org.gatein.pc.api.state.AccessMode
- toString() - Method in class org.gatein.pc.api.state.DestroyCloneFailure
- toString() - Method in enum org.gatein.pc.api.StateEvent.Type
- toString() - Method in class org.gatein.pc.api.StatefulPortletContext
- toString() - Method in class org.gatein.pc.api.WindowState
- toString(S) - Method in class org.gatein.pc.api.PortletStateType
- TransportGuarantee - Enum in org.gatein.pc.api
-
Type safe enumeration class for transport guarantee.
- TYPE_BYTES - Static variable in class org.gatein.pc.api.invocation.response.ContentResponse
-
.
- TYPE_CHARS - Static variable in class org.gatein.pc.api.invocation.response.ContentResponse
-
.
- TYPE_EMPTY - Static variable in class org.gatein.pc.api.invocation.response.ContentResponse
-
.
- TypeInfo - Interface in org.gatein.pc.api.info
U
- UnavailableResponse - Class in org.gatein.pc.api.invocation.response
-
Portlet exists but cannot be used.
- UnavailableResponse() - Constructor for class org.gatein.pc.api.invocation.response.UnavailableResponse
- UnavailableResponse(int) - Constructor for class org.gatein.pc.api.invocation.response.UnavailableResponse
- update(PropertyChange[]) - Method in interface org.gatein.pc.api.state.PropertyContext
-
Update the preferences.
- UpdateNavigationalStateResponse - Class in org.gatein.pc.api.invocation.response
-
Update the navigational state.
- UpdateNavigationalStateResponse() - Constructor for class org.gatein.pc.api.invocation.response.UpdateNavigationalStateResponse
- UpdateNavigationalStateResponse.Event - Class in org.gatein.pc.api.invocation.response
-
An event produced by a state response.
- URLFormat - Class in org.gatein.pc.api
-
Defines how a container URL should be formatted when rendered.
- URLFormat(Boolean, Boolean, Boolean, Boolean) - Constructor for class org.gatein.pc.api.URLFormat
- userContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The user context.
- UserContext - Interface in org.gatein.pc.api.spi
-
The user context valid during the scope of a single request.
V
- value - Variable in class org.gatein.pc.api.state.Property
-
The property value.
- valueOf(String) - Static method in enum org.gatein.pc.api.cache.CacheScope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.gatein.pc.api.LifeCyclePhase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.gatein.pc.api.PortletStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.gatein.pc.api.state.AccessMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.gatein.pc.api.StateEvent.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.gatein.pc.api.TransportGuarantee
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.gatein.pc.api.cache.CacheScope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.gatein.pc.api.LifeCyclePhase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.gatein.pc.api.PortletStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.gatein.pc.api.state.AccessMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.gatein.pc.api.StateEvent.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.gatein.pc.api.TransportGuarantee
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VIEW - Static variable in class org.gatein.pc.api.Mode
-
.
W
- windowContext - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
The window context.
- WindowContext - Interface in org.gatein.pc.api.spi
- windowState - Variable in class org.gatein.pc.api.invocation.PortletInvocation
-
.
- WindowState - Class in org.gatein.pc.api
- WindowState(String) - Constructor for class org.gatein.pc.api.WindowState
-
This NEEDS to be public for JAXB unmarshalling done by SupportsMetaData.
- WindowStateInfo - Interface in org.gatein.pc.api.info
- writeTo(DataOutputStream) - Method in class org.gatein.pc.api.OpaqueStateString
- writeTo(DataOutputStream) - Method in class org.gatein.pc.api.ParametersStateString
- writeTo(DataOutputStream) - Method in class org.gatein.pc.api.StateString
All Classes All Packages