org.gatein.wsrp

Class WSRPTypeFactory

java.lang.Object

org.gatein.wsrp.WSRPTypeFactory

public class WSRPTypeFactory
extends Object

Creates minimally valid instances of WSRP types, populated with default values where possible, as per wsrp_v2_types.xsd.

Since:

2.4

Version:

$Revision: 11317 $

Author:

Chris Laprun

Method Summary

Methods

Modifier and Type	Method and Description
static BlockingInteractionResponse	createBlockingInteractionResponse(String redirectURL)
static BlockingInteractionResponse	createBlockingInteractionResponse(UpdateResponse updateResponse) ====== WSRP Response objects ====== *
static CacheControl	createCacheControl(int expires, String userScope) expires(xsd:int), userScope(xsd:string), validateTag(xsd:string)?, extensions(Extension)*
static ClientData	createClientData(String userAgent) userAgent(xsd:string)?, extensions(Extension)*
static ClientData	createClientData(String userAgent, String requestVerb) userAgent(xsd:string)?, requestVerb(xsd:string)?, extensions(Extension)*
static ClonePortlet	createClonePortlet(RegistrationContext registrationContext, PortletContext portletContext, UserContext userContext) registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?
static Contact	createContact(Postal postal, Telecom telecom, Online online)
static CopiedPortlet	createCopiedPortlet(PortletContext newPortletContext, String fromPortletHandle)
static CopyPortlets	createCopyPortlets(RegistrationContext toRegistrationContext, UserContext toUserContext, RegistrationContext fromRegistrationContext, UserContext fromUserContext, List<PortletContext> fromPortletContexts)
static CopyPortletsResponse	createCopyPortletsResponse(List<CopiedPortlet> copiedPortlets, List<FailedPortlets> failedPortlets, ResourceList resourceList)
static RegistrationData	createDefaultRegistrationData() Same as createRegistrationData(WSRPConstants.DEFAULT_CONSUMER_NAME, false) using WSRPConstants.CONSUMER_AGENT for the consumer agent.
static ResourceParams	createDefaultResourceParams(String resourceID)
static Deregister	createDeregister(RegistrationContext registrationContext, UserContext userContext)
static DestroyPortlets	createDestroyPortlets(RegistrationContext registrationContext, List<String> portletHandles)
static DestroyPortletsResponse	createDestroyPortletsResponse(List<FailedPortlets> failedPortlets) failedPortlets(FailedPortlets)*, extensions(Extension)*
static EmployerInfo	createEmployerInfo(String employer, String department, String jobTitle)
static Event	createEvent(QName name, Serializable payload)
static EventDescription	createEventDescription(QName name)
static EventParams	createEventParams(List<Event> events, StateChange portletStateChange)
static EventPayload	createEventPayloadAsAny(Object value)
static EventPayload	createEventPayloadAsNamedString(NamedStringArray payload)
static ExportedPortlet	createExportedPortlet(String portletHandle, byte[] exportData)
static ExportPortlets	createExportPortlets(RegistrationContext registrationContext, List<PortletContext> portletContexts, UserContext userContext, Lifetime lifetime, Boolean exportByValue)
static ExportPortletsResponse	createExportPortletsResponse(byte[] exportContext, List<ExportedPortlet> exportedPortlets, List<FailedPortlets> failedPortlets, Lifetime lifetime, ResourceList resourceList)
static Extension	createExtension(Object any)
static FailedPortlets	createFailedPortlets(Collection<String> portletHandles, ErrorCodes.Codes errorCode, String reason) reason(LocalizedString)?, resourceList(ResourceList)?, extensions(Extension)* errorCode(ErrorCodes) portletHandles(xsd:string)+
static GetMarkup	createGetMarkup(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams) RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams
static GetPortletDescription	createGetPortletDescription(RegistrationContext registrationContext, org.gatein.pc.api.PortletContext portletContext)
static GetPortletDescription	createGetPortletDescription(RegistrationContext registrationContext, PortletContext portletContext, UserContext userContext)
static GetPortletDescription	createGetPortletDescription(RegistrationContext registrationContext, String portletHandle) registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*
static GetPortletProperties	createGetPortletProperties(RegistrationContext registrationContext, PortletContext portletContext, UserContext userContext, List<String> names)
static GetPortletPropertyDescription	createGetPortletPropertyDescription(RegistrationContext registrationContext, PortletContext portletContext, UserContext userContext, List<String> desiredLocales) registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*
static GetPortletsLifetime	createGetPortletsLifetime(RegistrationContext registrationContext, List<PortletContext> portletContext, UserContext userContext)
static GetResource	createGetResource(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, ResourceParams resourceParams) RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), ResourceParams
static GetServiceDescription	createGetServiceDescription(RegistrationContext registrationContext, UserContext userContext) registrationContext(RegistrationContext, nillable), desiredLocales(xsd:string)*, portletHandles(xsd:string)*, userContext(UserContext, nillable)
static HandleEvents	createHandleEvents(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams, EventParams eventParams) RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams, EventParams
static HandleEventsResponse	createHandleEventsReponse()
static ImportedPortlet	createImportedPortlet(String portletID, PortletContext portletContext)
static ImportPortlet	createImportPortlet(String importID, byte[] exportData)
static ImportPortlets	createImportPortlets(RegistrationContext registrationContext, byte[] importContext, List<ImportPortlet> importPortlet, UserContext userContext, Lifetime lifetime)
static ImportPortletsFailed	createImportPortletsFailed(List<String> importIds, ErrorCodes.Codes errorCode, String reason)
static ImportPortletsResponse	createImportPortletsResponse(List<ImportedPortlet> importedPortlets, List<ImportPortletsFailed> importPortletsFailed, ResourceList resourceList)
static InitCookie	createInitCookie(RegistrationContext registrationContext)
static InteractionParams	createInteractionParams(StateChange portletStateChange)
static ItemDescription	createItemDescription(LocalizedString description, LocalizedString displayName, String itemName)
static LocalizedString	createLocalizedString(String value) Same as createLocalizedString("en", null, value)
static LocalizedString	createLocalizedString(String lang, String resourceName, String value) value(xsd:string), @xml:lang, @resourceName(xsd:string)?
static MarkupContext	createMarkupContext(String mediaType, String markupString, byte[] markupBinary, Boolean useCachedItem) mimeType: The mime type of the returned markup.
static MarkupParams	createMarkupParams(boolean secureClientCommunication, List<String> locales, List<String> mimeTypes, String mode, String windowState)
static MarkupResponse	createMarkupResponse(MarkupContext markupContext)
static MarkupType	createMarkupType(String mimeType, List<String> modeNames, List<String> windowStateNames, List<String> localeNames)
static <T extends MimeResponse> T	createMimeResponse(String mimeType, String itemString, byte[] itemBinary, Class<T> clazz)
static MissingParametersFault	createMissingParametersFault()
static ModelDescription	createModelDescription(List<PropertyDescription> propertyDescriptions) propertyDescriptions(PropertyDescription)*, modelTypes(ModelTypes)?, extensions(Extension)*
static ModifyRegistration	createModifyRegistration(RegistrationContext registrationContext, RegistrationData registrationData) registrationContext(RegistrationContext)?, registrationData(RegistrationData)
static NamedString	createNamedString(String name, String value)
static NamedStringArray	createNamedStringArray()
static NavigationalContext	createNavigationalContext(String opaqueValue, List<NamedString> publicValues)
static NavigationalContext	createNavigationalContextOrNull(org.gatein.pc.api.StateString navigationalState, Map<String,String[]> publicNavigationalState)
static Online	createOnline(String email, String uri)
static OperationFailedFault	createOperationFailedFault()
static ParameterDescription	createParameterDescription(String identifier)
static PerformBlockingInteraction	createPerformBlockingInteraction(RegistrationContext registrationContext, PortletContext portletContext, RuntimeContext runtimeContext, UserContext userContext, MarkupParams markupParams, InteractionParams interactionParams) RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams, InteractionParams
static PersonName	createPersonName(String prefix, String given, String family, String middle, String suffix, String nickname)
static PortletContext	createPortletContext(String portletHandle)
static PortletContext	createPortletContext(String portletHandle, byte[] portletState)
static PortletDescription	createPortletDescription(String portletHandle, List<MarkupType> markupTypes)
static PortletDescriptionResponse	createPortletDescriptionResponse(PortletDescription portletDescription) portletDescription(PortletDescription), resourceList(ResourceList)?, extensions(Extension)*
static PortletPropertyDescriptionResponse	createPortletPropertyDescriptionResponse(List<PropertyDescription> propertyDescriptions) modelDescription(ModelDescription)?, resourceList(ResourceList)?, extensions(Extension)*
static Postal	createPostal(String name, String street, String city, String stateprov, String postalCode, String country, String organization)
static Property	createProperty(QName name, String lang, String stringValue)
static Property	createProperty(String name, String lang, String stringValue)
static PropertyDescription	createPropertyDescription(String name, QName type) label(LocalizedString)?, hint(LocalizedString)?, extensions(Extension)*, @name(xsd:string), @type(xsd:QName)
static PropertyList	createPropertyList() properties(Property)*, resetProperties(ResetProperty)*, extensions(Extension)*
static Register	createRegister(RegistrationData registrationData, Lifetime lifetime, UserContext userContext)
static RegistrationContext	createRegistrationContext(String registrationHandle) registrationHandle(xsd:string), registrationState(xsd:base64Binary)?, extensions(Extension)*
static RegistrationData	createRegistrationData(String consumerName, String consumerAgent, boolean methodGetSupported)
static ReleaseExport	createReleaseExport(RegistrationContext registrationContext, byte[] exportContext, UserContext userContext)
static ReleaseSessions	createReleaseSessions(RegistrationContext registrationContext, List<String> sessionIDs) registrationContext(RegistrationContext)?, sessionIDs(xsd:string)*
static ResetProperty	createResetProperty(String name) EMPTY, @name(xsd:string)
static Resource	createResource(String resourceName, List<ResourceValue> resourceValue)
static ResourceContext	createResourceContext(String mediaType, String resourceString, byte[] resourceBinary)
static ResourceList	createResourceList(List<Resource> resources)
static ResourceParams	createResourceParams(boolean secureClientCommunication, List<String> locales, List<String> mimeTypes, String mode, String windowState, String resourceID, StateChange stateChange)
static ResourceParams	createResourceParams(boolean secureClientCommunication, List<String> locales, List<String> mimeTypes, String mode, String windowState, String resourceID, StateChange stateChange, Map<String,String[]> parameters)
static ResourceResponse	createResourceResponse(ResourceContext resourceContext)
static ResourceValue	createResourceValue(String lang, String value)
static ReturnAny	createReturnAny()
static RuntimeContext	createRuntimeContext(String userAuthentication, String portletInstanceKey, String namespacePrefix)
static ServiceDescription	createServiceDescription(boolean requiresRegistration)
static SessionContext	createSessionContext(String sessionID, int expires)
static SessionParams	createSessionParams(String sessionID)
static SetExportLifetime	createSetExportLifetime(RegistrationContext registrationContext, byte[] exportContext, UserContext userContext, Lifetime lifetime)
static SetPortletProperties	createSetPortletProperties(RegistrationContext registrationContext, PortletContext portletContext, PropertyList propertyList) registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, propertyList(PropertyList)
static SetPortletsLifetime	createSetPortletsLifetime(RegistrationContext registrationContext, List<PortletContext> portletContext, UserContext userContext, Lifetime lifetime)
static ClonePortlet	createSimpleClonePortlet(String portletHandle) same as createClonePortlet(null, createPortletContext(portletHandle), null)
static GetPortletPropertyDescription	createSimpleGetPortletPropertyDescription(String portletHandle) Same as createGetPortletPropertyDescription(null, createPortletContext(portletHandle), null, null)
static Telecom	createTelecom(TelephoneNum telephone, TelephoneNum fax, TelephoneNum mobile, TelephoneNum pager)
static TelephoneNum	createTelephoneNum(String intCode, String loccode, String number, String ext, String comment)
static Templates	createTemplates(org.gatein.pc.api.spi.PortletInvocationContext context) defaultTemplate(xsd:string)?, blockingActionTemplate(xsd:string)?, renderTemplate(xsd:string)?, resourceTemplate(xsd:string)?, secureDefaultTemplate(xsd:string)?, secureBlockingActionTemplate(xsd:string)?, secureRenderTemplate(xsd:string)?, secureResourceTemplate(xsd:string)?, extensions(Extension)*
static Templates	createTemplates(String defaultTemplate, String blockingActionTemplate, String renderTemplate, String resourceTemplate, String secureDefaultTemplate, String secureBlockingActionTemplate, String secureRenderTemplate, String secureResourceTemplate)
static UpdateResponse	createUpdateResponse()
static UploadContext	createUploadContext(String mimeType, byte[] uploadData) mimeType(xsd:string), uploadData(xsd:base64Binary), mimeAttributes(NamedString)*, extensions(Extension)*
static UserContext	createUserContext(String userContextKey) For UserProfile and related classes, everything is optional so no need to have factory methods.
static UserProfile	createUserProfile(PersonName name, XMLGregorianCalendar bdate, String gender, EmployerInfo employerInfo, Contact homeInfo, Contact businessInfo)
static String	getNamespaceFrom(org.gatein.pc.api.spi.WindowContext windowContext)
static String	getNamespacePrefix(org.gatein.pc.api.spi.WindowContext windowContext, String portletHandle)
static String	getPortletInstanceKey(org.gatein.pc.api.spi.InstanceContext instanceContext)

Methods inherited from class java.lang.Object

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

Method Detail

createGetServiceDescription

public static GetServiceDescription createGetServiceDescription(RegistrationContext registrationContext,
                                                UserContext userContext)

registrationContext(RegistrationContext, nillable), desiredLocales(xsd:string)*, portletHandles(xsd:string)*, userContext(UserContext, nillable)

Parameters:

registrationContext - can be null

userContext - can be null

Returns:

createGetMarkup

public static GetMarkup createGetMarkup(RegistrationContext registrationContext,
                        PortletContext portletContext,
                        RuntimeContext runtimeContext,
                        UserContext userContext,
                        MarkupParams markupParams)

RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams

Parameters:

registrationContext - can be null

portletContext -

runtimeContext -

userContext - can be null

markupParams -

Returns:

Throws:

IllegalArgumentException - if one of the required, non-nillable parameters is null

createGetResource

public static GetResource createGetResource(RegistrationContext registrationContext,
                            PortletContext portletContext,
                            RuntimeContext runtimeContext,
                            UserContext userContext,
                            ResourceParams resourceParams)

RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), ResourceParams

Parameters:

registrationContext - can be null

portletContext -

runtimeContext -

userContext - can be null

resourceParams -

Returns:

Throws:

IllegalArgumentException - if one of the required, non-nillable parameters is null

createPerformBlockingInteraction

public static PerformBlockingInteraction createPerformBlockingInteraction(RegistrationContext registrationContext,
                                                          PortletContext portletContext,
                                                          RuntimeContext runtimeContext,
                                                          UserContext userContext,
                                                          MarkupParams markupParams,
                                                          InteractionParams interactionParams)

RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams, InteractionParams

Parameters:

registrationContext - can be null

portletContext -

runtimeContext -

userContext - can be null

markupParams -

interactionParams -

Returns:

Throws:

IllegalArgumentException - if one of the required, non-nillable parameters is null

createHandleEvents

public static HandleEvents createHandleEvents(RegistrationContext registrationContext,
                              PortletContext portletContext,
                              RuntimeContext runtimeContext,
                              UserContext userContext,
                              MarkupParams markupParams,
                              EventParams eventParams)

RegistrationContext (nillable), PortletContext, RuntimeContext, UserContext (nillable), MarkupParams, EventParams

Parameters:

registrationContext - can be null

portletContext -

runtimeContext -

userContext - can be null

markupParams -

eventParams -

Returns:

createGetPortletDescription

public static GetPortletDescription createGetPortletDescription(RegistrationContext registrationContext,
                                                String portletHandle)

registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*

Parameters:

registrationContext -

portletHandle - handle for the PortletContext

Returns:

Since:

2.4.1

createGetPortletDescription

public static GetPortletDescription createGetPortletDescription(RegistrationContext registrationContext,
                                                PortletContext portletContext,
                                                UserContext userContext)

createGetPortletDescription

public static GetPortletDescription createGetPortletDescription(RegistrationContext registrationContext,
                                                org.gatein.pc.api.PortletContext portletContext)

Parameters:

registrationContext -

portletContext -

Returns:

Since:

2.6

createGetPortletProperties

public static GetPortletProperties createGetPortletProperties(RegistrationContext registrationContext,
                                              PortletContext portletContext,
                                              UserContext userContext,
                                              List<String> names)

createBlockingInteractionResponse

public static BlockingInteractionResponse createBlockingInteractionResponse(UpdateResponse updateResponse)

====== WSRP Response objects ====== *

createBlockingInteractionResponse

public static BlockingInteractionResponse createBlockingInteractionResponse(String redirectURL)

createUpdateResponse

public static UpdateResponse createUpdateResponse()

createPortletDescription

public static PortletDescription createPortletDescription(String portletHandle,
                                          List<MarkupType> markupTypes)

createMarkupParams

public static MarkupParams createMarkupParams(boolean secureClientCommunication,
                              List<String> locales,
                              List<String> mimeTypes,
                              String mode,
                              String windowState)

createDefaultResourceParams

public static ResourceParams createDefaultResourceParams(String resourceID)

createResourceParams

public static ResourceParams createResourceParams(boolean secureClientCommunication,
                                  List<String> locales,
                                  List<String> mimeTypes,
                                  String mode,
                                  String windowState,
                                  String resourceID,
                                  StateChange stateChange,
                                  Map<String,String[]> parameters)

createResourceParams

public static ResourceParams createResourceParams(boolean secureClientCommunication,
                                  List<String> locales,
                                  List<String> mimeTypes,
                                  String mode,
                                  String windowState,
                                  String resourceID,
                                  StateChange stateChange)

createRuntimeContext

public static RuntimeContext createRuntimeContext(String userAuthentication,
                                  String portletInstanceKey,
                                  String namespacePrefix)

createPortletContext

public static PortletContext createPortletContext(String portletHandle)

createPortletContext

public static PortletContext createPortletContext(String portletHandle,
                                  byte[] portletState)

createInteractionParams

public static InteractionParams createInteractionParams(StateChange portletStateChange)

createInitCookie

public static InitCookie createInitCookie(RegistrationContext registrationContext)

createServiceDescription

public static ServiceDescription createServiceDescription(boolean requiresRegistration)

createMarkupResponse

public static MarkupResponse createMarkupResponse(MarkupContext markupContext)

createResourceResponse

public static ResourceResponse createResourceResponse(ResourceContext resourceContext)

createMarkupContext

public static MarkupContext createMarkupContext(String mediaType,
                                String markupString,
                                byte[] markupBinary,
                                Boolean useCachedItem)

mimeType: The mime type of the returned markup. The mimeType field MUST be specified whenever markup is returned, and if the markupBinary field is used to return the markup, the mime type MUST include the character set for textual mime types using the syntax specified in RFC1522[14] (e.g. "text/html; charset=UTF-8"). In this particular case this character set MAY be different than the response message.

createResourceContext

public static ResourceContext createResourceContext(String mediaType,
                                    String resourceString,
                                    byte[] resourceBinary)

Parameters:

mediaType - The mime type of the returned resource. The mimeType field MUST be specified whenever resource is returned, and if the resourceBinary field is used to return the resource, the mime type MUST include the character set for textual mime types using the syntax specified in RFC1522[14] (e.g. "text/html; charset=UTF-8"). In this particular case this character set MAY be different than the response message.

Returns:

a new ResourceContext

createMimeResponse

public static <T extends MimeResponse> T createMimeResponse(String mimeType,
                                            String itemString,
                                            byte[] itemBinary,
                                            Class<T> clazz)

createSessionContext

public static SessionContext createSessionContext(String sessionID,
                                  int expires)

Parameters:

sessionID - An opaque string the Portlet defines for referencing state that is stored locally on the Producer. The maximum length of a sessionID is 4096 characters,

expires - Maximum number of seconds between invocations referencing the sessionID before the Producer will schedule releasing the related resources. A value of -1 indicates that the sessionID will never expire.

Returns:

a new SessionContext

createUserContext

public static UserContext createUserContext(String userContextKey)

For UserProfile and related classes, everything is optional so no need to have factory methods.

createRegistrationData

public static RegistrationData createRegistrationData(String consumerName,
                                      String consumerAgent,
                                      boolean methodGetSupported)

Parameters:

consumerName - A name (preferably unique) that identifies the Consumer [R355] An example of such a name would be the Consumer's URL.

methodGetSupported - A flag that tells the Producer whether the Consumer has implemented portlet URLs (regardless of whether they are written through Consumer URL rewriting or Producer URL writing, see [Section 10.2]) in a manner that supports HTML markup containing forms with method="get".

Returns:

createDefaultRegistrationData

public static RegistrationData createDefaultRegistrationData()

Same as createRegistrationData(WSRPConstants.DEFAULT_CONSUMER_NAME, false) using WSRPConstants.CONSUMER_AGENT for the consumer agent.

Returns:

Since:

2.4.1

createProperty

public static Property createProperty(String name,
                      String lang,
                      String stringValue)

createProperty

public static Property createProperty(QName name,
                      String lang,
                      String stringValue)

createTemplates

public static Templates createTemplates(org.gatein.pc.api.spi.PortletInvocationContext context)

defaultTemplate(xsd:string)?, blockingActionTemplate(xsd:string)?, renderTemplate(xsd:string)?, resourceTemplate(xsd:string)?, secureDefaultTemplate(xsd:string)?, secureBlockingActionTemplate(xsd:string)?, secureRenderTemplate(xsd:string)?, secureResourceTemplate(xsd:string)?, extensions(Extension)*

Parameters:

context -

Returns:

createTemplates

public static Templates createTemplates(String defaultTemplate,
                        String blockingActionTemplate,
                        String renderTemplate,
                        String resourceTemplate,
                        String secureDefaultTemplate,
                        String secureBlockingActionTemplate,
                        String secureRenderTemplate,
                        String secureResourceTemplate)

createClientData

public static ClientData createClientData(String userAgent)

userAgent(xsd:string)?, extensions(Extension)*

Parameters:

userAgent -

Returns:

createClientData

public static ClientData createClientData(String userAgent,
                          String requestVerb)

userAgent(xsd:string)?, requestVerb(xsd:string)?, extensions(Extension)*

Parameters:

userAgent -

requestVerb -

Returns:

createCacheControl

public static CacheControl createCacheControl(int expires,
                              String userScope)

expires(xsd:int), userScope(xsd:string), validateTag(xsd:string)?, extensions(Extension)*

Parameters:

expires - Number of seconds the markup fragment referenced by this cache control entry remains valid. A value of -1 indicates that the markup fragment will never expire.

userScope -

Returns:

createRegistrationContext

public static RegistrationContext createRegistrationContext(String registrationHandle)

registrationHandle(xsd:string), registrationState(xsd:base64Binary)?, extensions(Extension)*

Parameters:

registrationHandle -

Returns:

Since:

2.4.1

createModelDescription

public static ModelDescription createModelDescription(List<PropertyDescription> propertyDescriptions)

propertyDescriptions(PropertyDescription)*, modelTypes(ModelTypes)?, extensions(Extension)*

Returns:

Since:

2.6

createPropertyDescription

public static PropertyDescription createPropertyDescription(String name,
                                            QName type)

label(LocalizedString)?, hint(LocalizedString)?, extensions(Extension)*, @name(xsd:string), @type(xsd:QName)

Returns:

Since:

2.6

createLocalizedString

public static LocalizedString createLocalizedString(String lang,
                                    String resourceName,
                                    String value)

value(xsd:string), @xml:lang, @resourceName(xsd:string)?

Returns:

Since:

2.6

createLocalizedString

public static LocalizedString createLocalizedString(String value)

Same as createLocalizedString("en", null, value)

Parameters:

value -

Returns:

Since:

2.6

createPortletDescriptionResponse

public static PortletDescriptionResponse createPortletDescriptionResponse(PortletDescription portletDescription)

portletDescription(PortletDescription), resourceList(ResourceList)?, extensions(Extension)*

Parameters:

portletDescription -

Returns:

Since:

2.6

createPortletPropertyDescriptionResponse

public static PortletPropertyDescriptionResponse createPortletPropertyDescriptionResponse(List<PropertyDescription> propertyDescriptions)

modelDescription(ModelDescription)?, resourceList(ResourceList)?, extensions(Extension)*

Parameters:

propertyDescriptions -

Returns:

Since:

2.6

createGetPortletPropertyDescription

public static GetPortletPropertyDescription createGetPortletPropertyDescription(RegistrationContext registrationContext,
                                                                PortletContext portletContext,
                                                                UserContext userContext,
                                                                List<String> desiredLocales)

registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*

Returns:

Since:

2.6

createSimpleGetPortletPropertyDescription

public static GetPortletPropertyDescription createSimpleGetPortletPropertyDescription(String portletHandle)

Same as createGetPortletPropertyDescription(null, createPortletContext(portletHandle), null, null)

Parameters:

portletHandle -

Returns:

Since:

2.6

createSetPortletProperties

public static SetPortletProperties createSetPortletProperties(RegistrationContext registrationContext,
                                              PortletContext portletContext,
                                              PropertyList propertyList)

registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, propertyList(PropertyList)

Parameters:

portletContext -

propertyList -

Returns:

Since:

2.6

createSimpleClonePortlet

public static ClonePortlet createSimpleClonePortlet(String portletHandle)

same as createClonePortlet(null, createPortletContext(portletHandle), null)

Parameters:

portletHandle -

Returns:

Since:

2.6

createClonePortlet

public static ClonePortlet createClonePortlet(RegistrationContext registrationContext,
                              PortletContext portletContext,
                              UserContext userContext)

registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?

Returns:

Since:

2.6

createDestroyPortlets

public static DestroyPortlets createDestroyPortlets(RegistrationContext registrationContext,
                                    List<String> portletHandles)

createPropertyList

public static PropertyList createPropertyList()

properties(Property)*, resetProperties(ResetProperty)*, extensions(Extension)*

Returns:

Since:

2.6

createResetProperty

public static ResetProperty createResetProperty(String name)

EMPTY, @name(xsd:string)

Parameters:

name -

Returns:

Since:

2.6

createReleaseSessions

public static ReleaseSessions createReleaseSessions(RegistrationContext registrationContext,
                                    List<String> sessionIDs)

registrationContext(RegistrationContext)?, sessionIDs(xsd:string)*

Returns:

Since:

2.6

createModifyRegistration

public static ModifyRegistration createModifyRegistration(RegistrationContext registrationContext,
                                          RegistrationData registrationData)

registrationContext(RegistrationContext)?, registrationData(RegistrationData)

Returns:

Since:

2.6

createUploadContext

public static UploadContext createUploadContext(String mimeType,
                                byte[] uploadData)

mimeType(xsd:string), uploadData(xsd:base64Binary), mimeAttributes(NamedString)*, extensions(Extension)*

Parameters:

mimeType -

uploadData -

Returns:

Since:

2.6.2

createMarkupType

public static MarkupType createMarkupType(String mimeType,
                          List<String> modeNames,
                          List<String> windowStateNames,
                          List<String> localeNames)

createFailedPortlets

public static FailedPortlets createFailedPortlets(Collection<String> portletHandles,
                                  ErrorCodes.Codes errorCode,
                                  String reason)

reason(LocalizedString)?, resourceList(ResourceList)?, extensions(Extension)* errorCode(ErrorCodes) portletHandles(xsd:string)+

Parameters:

portletHandles -

reason -

Returns:

createDestroyPortletsResponse

public static DestroyPortletsResponse createDestroyPortletsResponse(List<FailedPortlets> failedPortlets)

failedPortlets(FailedPortlets)*, extensions(Extension)*

Parameters:

failedPortlets -

Returns:

createNavigationalContextOrNull

public static NavigationalContext createNavigationalContextOrNull(org.gatein.pc.api.StateString navigationalState,
                                                  Map<String,String[]> publicNavigationalState)

createNavigationalContext

public static NavigationalContext createNavigationalContext(String opaqueValue,
                                            List<NamedString> publicValues)

createParameterDescription

public static ParameterDescription createParameterDescription(String identifier)

createEventDescription

public static EventDescription createEventDescription(QName name)

createHandleEventsReponse

public static HandleEventsResponse createHandleEventsReponse()

createEventParams

public static EventParams createEventParams(List<Event> events,
                            StateChange portletStateChange)

createEvent

public static Event createEvent(QName name,
                Serializable payload)

createEventPayloadAsAny

public static EventPayload createEventPayloadAsAny(Object value)

createNamedString

public static NamedString createNamedString(String name,
                            String value)

createEventPayloadAsNamedString

public static EventPayload createEventPayloadAsNamedString(NamedStringArray payload)

createExportPortlets

public static ExportPortlets createExportPortlets(RegistrationContext registrationContext,
                                  List<PortletContext> portletContexts,
                                  UserContext userContext,
                                  Lifetime lifetime,
                                  Boolean exportByValue)

createExportPortletsResponse

public static ExportPortletsResponse createExportPortletsResponse(byte[] exportContext,
                                                  List<ExportedPortlet> exportedPortlets,
                                                  List<FailedPortlets> failedPortlets,
                                                  Lifetime lifetime,
                                                  ResourceList resourceList)

createExportedPortlet

public static ExportedPortlet createExportedPortlet(String portletHandle,
                                    byte[] exportData)

createImportPortlets

public static ImportPortlets createImportPortlets(RegistrationContext registrationContext,
                                  byte[] importContext,
                                  List<ImportPortlet> importPortlet,
                                  UserContext userContext,
                                  Lifetime lifetime)

createImportPortlet

public static ImportPortlet createImportPortlet(String importID,
                                byte[] exportData)

createImportPortletsResponse

public static ImportPortletsResponse createImportPortletsResponse(List<ImportedPortlet> importedPortlets,
                                                  List<ImportPortletsFailed> importPortletsFailed,
                                                  ResourceList resourceList)

createImportPortletsFailed

public static ImportPortletsFailed createImportPortletsFailed(List<String> importIds,
                                              ErrorCodes.Codes errorCode,
                                              String reason)

createImportedPortlet

public static ImportedPortlet createImportedPortlet(String portletID,
                                    PortletContext portletContext)

createReleaseExport

public static ReleaseExport createReleaseExport(RegistrationContext registrationContext,
                                byte[] exportContext,
                                UserContext userContext)

createSetExportLifetime

public static SetExportLifetime createSetExportLifetime(RegistrationContext registrationContext,
                                        byte[] exportContext,
                                        UserContext userContext,
                                        Lifetime lifetime)

createContact

public static Contact createContact(Postal postal,
                    Telecom telecom,
                    Online online)

createPostal

public static Postal createPostal(String name,
                  String street,
                  String city,
                  String stateprov,
                  String postalCode,
                  String country,
                  String organization)

createTelecom

public static Telecom createTelecom(TelephoneNum telephone,
                    TelephoneNum fax,
                    TelephoneNum mobile,
                    TelephoneNum pager)

createTelephoneNum

public static TelephoneNum createTelephoneNum(String intCode,
                              String loccode,
                              String number,
                              String ext,
                              String comment)

createOnline

public static Online createOnline(String email,
                  String uri)

createEmployerInfo

public static EmployerInfo createEmployerInfo(String employer,
                              String department,
                              String jobTitle)

createPersonName

public static PersonName createPersonName(String prefix,
                          String given,
                          String family,
                          String middle,
                          String suffix,
                          String nickname)

createExtension

public static Extension createExtension(Object any)

createMissingParametersFault

public static MissingParametersFault createMissingParametersFault()

createOperationFailedFault

public static OperationFailedFault createOperationFailedFault()

createItemDescription

public static ItemDescription createItemDescription(LocalizedString description,
                                    LocalizedString displayName,
                                    String itemName)

createResource

public static Resource createResource(String resourceName,
                      List<ResourceValue> resourceValue)

createResourceList

public static ResourceList createResourceList(List<Resource> resources)

createResourceValue

public static ResourceValue createResourceValue(String lang,
                                String value)

createReturnAny

public static ReturnAny createReturnAny()

createSessionParams

public static SessionParams createSessionParams(String sessionID)

createUserProfile

public static UserProfile createUserProfile(PersonName name,
                            XMLGregorianCalendar bdate,
                            String gender,
                            EmployerInfo employerInfo,
                            Contact homeInfo,
                            Contact businessInfo)

createCopyPortlets

public static CopyPortlets createCopyPortlets(RegistrationContext toRegistrationContext,
                              UserContext toUserContext,
                              RegistrationContext fromRegistrationContext,
                              UserContext fromUserContext,
                              List<PortletContext> fromPortletContexts)

createCopyPortletsResponse

public static CopyPortletsResponse createCopyPortletsResponse(List<CopiedPortlet> copiedPortlets,
                                              List<FailedPortlets> failedPortlets,
                                              ResourceList resourceList)

createCopiedPortlet

public static CopiedPortlet createCopiedPortlet(PortletContext newPortletContext,
                                String fromPortletHandle)

createNamedStringArray

public static NamedStringArray createNamedStringArray()

getPortletInstanceKey

public static String getPortletInstanceKey(org.gatein.pc.api.spi.InstanceContext instanceContext)

getNamespacePrefix

public static String getNamespacePrefix(org.gatein.pc.api.spi.WindowContext windowContext,
                        String portletHandle)

getNamespaceFrom

public static String getNamespaceFrom(org.gatein.pc.api.spi.WindowContext windowContext)

createGetPortletsLifetime

public static GetPortletsLifetime createGetPortletsLifetime(RegistrationContext registrationContext,
                                            List<PortletContext> portletContext,
                                            UserContext userContext)

createSetPortletsLifetime

public static SetPortletsLifetime createSetPortletsLifetime(RegistrationContext registrationContext,
                                            List<PortletContext> portletContext,
                                            UserContext userContext,
                                            Lifetime lifetime)

createRegister

public static Register createRegister(RegistrationData registrationData,
                      Lifetime lifetime,
                      UserContext userContext)

createDeregister

public static Deregister createDeregister(RegistrationContext registrationContext,
                          UserContext userContext)