MarkupService (GateIn WSRP Consumer 2.3.2.Final API)

java.lang.Object
- org.gatein.wsrp.services.WSRPService<T>
- - org.gatein.wsrp.services.MarkupService<T>

All Implemented Interfaces:

WSRPV2MarkupPortType

Direct Known Subclasses:

V1MarkupService, V2MarkupService
```
public abstract class MarkupService<T>
extends WSRPService<T>
implements WSRPV2MarkupPortType
```
Version:

$Revision$

Author:

Chris Laprun

Field Summary
- Fields inherited from class org.gatein.wsrp.services.WSRPService
  service

Constructor Summary

Constructors
Modifier Constructor and Description

protected MarkupService(T service)

Constructors
Modifier	Constructor and Description
`protected`	`MarkupService(T service)`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`getMarkup(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams, Holder<MarkupContext> markupContext, Holder<SessionContext> sessionContext, Holder<List<Extension>> extensions)`
`abstract void`	`getResource(RegistrationContext registrationContext, Holder<PortletContext> portletContext, RuntimeContext runtimeContext, UserContext userContext, ResourceParams resourceParams, Holder<ResourceContext> resourceContext, Holder<SessionContext> sessionContext, Holder<List<Extension>> extensions)`
`abstract void`	`handleEvents(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams, EventParams eventParams, Holder<UpdateResponse> updateResponse, Holder<List<HandleEventsFailed>> failedEvents, Holder<List<Extension>> extensions)`
`abstract List<Extension>`	`initCookie(RegistrationContext registrationContext, UserContext userContext)`
`abstract void`	`performBlockingInteraction(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams, InteractionParams interactionParams, Holder<UpdateResponse> updateResponse, Holder<String> redirectURL, Holder<List<Extension>> extensions)`
`abstract List<Extension>`	`releaseSessions(RegistrationContext registrationContext, List<String> sessionIDs, UserContext userContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MarkupService
```
protected MarkupService(T service)
```

Method Detail

getMarkup

public abstract void getMarkup(RegistrationContext registrationContext,
             PortletContext portletContext,
             RuntimeContext runtimeContext,
             UserContext userContext,
             MarkupParams markupParams,
             Holder<MarkupContext> markupContext,
             Holder<SessionContext> sessionContext,
             Holder<List<Extension>> extensions)
                        throws AccessDenied,
                               InconsistentParameters,
                               InvalidCookie,
                               InvalidHandle,
                               InvalidRegistration,
                               InvalidSession,
                               InvalidUserCategory,
                               MissingParameters,
                               ModifyRegistrationRequired,
                               OperationFailed,
                               ResourceSuspended,
                               UnsupportedLocale,
                               UnsupportedMimeType,
                               UnsupportedMode,
                               UnsupportedWindowState

Specified by:: getMarkup in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InconsistentParameters; InvalidCookie; InvalidHandle; InvalidRegistration; InvalidSession; InvalidUserCategory; MissingParameters; ModifyRegistrationRequired; OperationFailed; ResourceSuspended; UnsupportedLocale; UnsupportedMimeType; UnsupportedMode; UnsupportedWindowState

getResource

public abstract void getResource(RegistrationContext registrationContext,
               Holder<PortletContext> portletContext,
               RuntimeContext runtimeContext,
               UserContext userContext,
               ResourceParams resourceParams,
               Holder<ResourceContext> resourceContext,
               Holder<SessionContext> sessionContext,
               Holder<List<Extension>> extensions)
                          throws AccessDenied,
                                 InconsistentParameters,
                                 InvalidCookie,
                                 InvalidHandle,
                                 InvalidRegistration,
                                 InvalidSession,
                                 InvalidUserCategory,
                                 MissingParameters,
                                 ModifyRegistrationRequired,
                                 OperationFailed,
                                 OperationNotSupported,
                                 ResourceSuspended,
                                 UnsupportedLocale,
                                 UnsupportedMimeType,
                                 UnsupportedMode,
                                 UnsupportedWindowState

Specified by:: getResource in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InconsistentParameters; InvalidCookie; InvalidHandle; InvalidRegistration; InvalidSession; InvalidUserCategory; MissingParameters; ModifyRegistrationRequired; OperationFailed; OperationNotSupported; ResourceSuspended; UnsupportedLocale; UnsupportedMimeType; UnsupportedMode; UnsupportedWindowState

performBlockingInteraction

public abstract void performBlockingInteraction(RegistrationContext registrationContext,
                              PortletContext portletContext,
                              RuntimeContext runtimeContext,
                              UserContext userContext,
                              MarkupParams markupParams,
                              InteractionParams interactionParams,
                              Holder<UpdateResponse> updateResponse,
                              Holder<String> redirectURL,
                              Holder<List<Extension>> extensions)
                                         throws AccessDenied,
                                                InconsistentParameters,
                                                InvalidCookie,
                                                InvalidHandle,
                                                InvalidRegistration,
                                                InvalidSession,
                                                InvalidUserCategory,
                                                MissingParameters,
                                                ModifyRegistrationRequired,
                                                OperationFailed,
                                                PortletStateChangeRequired,
                                                ResourceSuspended,
                                                UnsupportedLocale,
                                                UnsupportedMimeType,
                                                UnsupportedMode,
                                                UnsupportedWindowState

Specified by:: performBlockingInteraction in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InconsistentParameters; InvalidCookie; InvalidHandle; InvalidRegistration; InvalidSession; InvalidUserCategory; MissingParameters; ModifyRegistrationRequired; OperationFailed; PortletStateChangeRequired; ResourceSuspended; UnsupportedLocale; UnsupportedMimeType; UnsupportedMode; UnsupportedWindowState

handleEvents

public abstract void handleEvents(RegistrationContext registrationContext,
                PortletContext portletContext,
                RuntimeContext runtimeContext,
                UserContext userContext,
                MarkupParams markupParams,
                EventParams eventParams,
                Holder<UpdateResponse> updateResponse,
                Holder<List<HandleEventsFailed>> failedEvents,
                Holder<List<Extension>> extensions)
                           throws AccessDenied,
                                  InconsistentParameters,
                                  InvalidCookie,
                                  InvalidHandle,
                                  InvalidRegistration,
                                  InvalidSession,
                                  InvalidUserCategory,
                                  MissingParameters,
                                  ModifyRegistrationRequired,
                                  OperationFailed,
                                  OperationNotSupported,
                                  PortletStateChangeRequired,
                                  ResourceSuspended,
                                  UnsupportedLocale,
                                  UnsupportedMimeType,
                                  UnsupportedMode,
                                  UnsupportedWindowState

Specified by:: handleEvents in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InconsistentParameters; InvalidCookie; InvalidHandle; InvalidRegistration; InvalidSession; InvalidUserCategory; MissingParameters; ModifyRegistrationRequired; OperationFailed; OperationNotSupported; PortletStateChangeRequired; ResourceSuspended; UnsupportedLocale; UnsupportedMimeType; UnsupportedMode; UnsupportedWindowState

releaseSessions

public abstract List<Extension> releaseSessions(RegistrationContext registrationContext,
                              List<String> sessionIDs,
                              UserContext userContext)
                                         throws AccessDenied,
                                                InvalidRegistration,
                                                MissingParameters,
                                                ModifyRegistrationRequired,
                                                OperationFailed,
                                                OperationNotSupported,
                                                ResourceSuspended

Specified by:: releaseSessions in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InvalidRegistration; MissingParameters; ModifyRegistrationRequired; OperationFailed; OperationNotSupported; ResourceSuspended

initCookie

public abstract List<Extension> initCookie(RegistrationContext registrationContext,
                         UserContext userContext)
                                    throws AccessDenied,
                                           InvalidRegistration,
                                           ModifyRegistrationRequired,
                                           OperationFailed,
                                           OperationNotSupported,
                                           ResourceSuspended

Specified by:: initCookie in interface WSRPV2MarkupPortType
Throws:: AccessDenied; InvalidRegistration; ModifyRegistrationRequired; OperationFailed; OperationNotSupported; ResourceSuspended

Class MarkupService<T>

Field Summary

Fields inherited from class org.gatein.wsrp.services.WSRPService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MarkupService

Method Detail

getMarkup

getResource

performBlockingInteraction

handleEvents

releaseSessions

initCookie