public class WSRP1TypeFactory extends Object
| Modifier and Type | Method and Description |
|---|---|
static V1BlockingInteractionResponse |
createBlockingInteractionResponse(String redirectURL)
( updateResponse(UpdateResponse) | redirectURL(xsd:string) ), extensions(Extension)*
|
static V1BlockingInteractionResponse |
createBlockingInteractionResponse(V1UpdateResponse updateResponse)
( updateResponse(UpdateResponse) | redirectURL(xsd:string) ), extensions(Extension)*
|
static V1CacheControl |
createCacheControl(int expires,
String userScope)
expires(xsd:int), userScope(xsd:string), validateTag(xsd:string)?, extensions(Extension)*
|
static V1ClientData |
createClientData(String userAgent)
userAgent(xsd:string)?, extensions(Extension)*
|
static V1ClonePortlet |
createClonePortlet(V1RegistrationContext registrationContext,
V1PortletContext portletContext,
V1UserContext userContext)
registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?
|
static V1InteractionParams |
createDefaultInteractionParams()
Same as createInteractionParams(StateChange.readOnly)
|
static V1MarkupParams |
createDefaultMarkupParams()
Same as createMarkupParams(false,
WSRPConstants.getDefaultLocales(),
WSRPConstants.getDefaultMimeTypes(), WSRPConstants.VIEW_MODE,
WSRPConstants.NORMAL_WINDOW_STATE) |
static V1RegistrationData |
createDefaultRegistrationData()
Same as createRegistrationData(
WSRPConstants.DEFAULT_CONSUMER_NAME, false) using
WSRPConstants.CONSUMER_AGENT for the consumer agent. |
static V1DestroyFailed |
createDestroyFailed(String portletHandle,
String reason)
portletHandle(xsd:string), reason(xsd:string)
|
static V1DestroyPortlets |
createDestroyPortlets(V1RegistrationContext registrationContext,
List<String> portletHandles)
registrationContext(RegistrationContext)?, portletHandles(xsd:string)+
|
static V1DestroyPortletsResponse |
createDestroyPortletsResponse(List<V1DestroyFailed> destroyFailed)
destroyFailed(DestroyFailed)*, extensions(Extension)*
|
static V1GetPortletDescription |
createGetPortletDescription(V1RegistrationContext registrationContext,
org.gatein.pc.api.PortletContext portletContext) |
static V1GetPortletDescription |
createGetPortletDescription(V1RegistrationContext registrationContext,
String portletHandle)
registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?,
desiredLocales(xsd:string)*
|
static V1GetPortletProperties |
createGetPortletProperties(V1RegistrationContext registrationContext,
V1PortletContext portletContext)
registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?,
desiredLocales(xsd:string)*
|
static V1GetPortletPropertyDescription |
createGetPortletPropertyDescription(V1RegistrationContext registrationContext,
V1PortletContext portletContext,
V1UserContext userContext,
List<String> desiredLocales)
registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?,
desiredLocales(xsd:string)*
|
static V1GetServiceDescription |
createGetServiceDescription()
registrationContext(RegistrationContext)?, desiredLocales(xsd:string)*
|
static V1InitCookie |
createInitCookie(V1RegistrationContext registrationContext)
registrationContext(RegistrationContext)?
|
static V1InteractionParams |
createInteractionParams(V1StateChange portletStateChange)
portletStateChange(
V1StateChange), interactionState(xsd:string)?, formParameters(NamedString)*,
uploadContexts(UploadContext)*, extensions(Extension)* |
static V1LocalizedString |
createLocalizedString(String value)
Same as createLocalizedString("en", null, value)
|
static V1LocalizedString |
createLocalizedString(String lang,
String resourceName,
String value)
value(xsd:string), @xml:lang, @resourceName(xsd:string)?
|
static V1MarkupContext |
createMarkupContext(String mediaType,
String markupString,
byte[] markupBinary,
Boolean useCacheItem)
mimeType: The mime type of the returned markup.
|
static V1MarkupParams |
createMarkupParams(boolean secureClientCommunication,
List<String> locales,
List<String> mimeTypes,
String mode,
String windowState)
secureClientCommunication(xsd:boolean), locales(xsd:string)+, mimeTypes(xsd:string)+, mode(xsd:string),
windowState(xsd:string), clientData(
V1ClientData)?, navigationalState(xsd:string)?,
markupCharacterSets(xsd:string)*, validateTag(xsd:string)?, validNewModes(xsd:string)*,
validNewWindowStates(xsd:string)*, extensions(V1Extension)* |
static V1GetMarkup |
createMarkupRequest(V1PortletContext portletContext,
V1RuntimeContext runtimeContext,
V1MarkupParams markupParams)
registrationContext(RegistrationContext)?, portletContext(PortletContext), runtimeContext(RuntimeContext),
userContext(UserContext)?, markupParams(MarkupParams)
|
static V1MarkupResponse |
createMarkupResponse(V1MarkupContext markupContext)
markupContext(MarkupContext), sessionContext(SessionContext)?, extensions(Extension)*
|
static V1MarkupType |
createMarkupType(String mimeType,
List<String> modeNames,
List<String> windowStateNames,
List<String> localeNames) |
static V1ModelDescription |
createModelDescription(List<V1PropertyDescription> propertyDescriptions)
propertyDescriptions(PropertyDescription)*, modelTypes(ModelTypes)?, extensions(Extension)*
|
static V1ModifyRegistration |
createModifyRegistration(V1RegistrationContext registrationContext,
V1RegistrationData registrationData)
registrationContext(RegistrationContext)?, registrationData(RegistrationData)
|
static V1PerformBlockingInteraction |
createPerformBlockingInteraction(V1PortletContext portletContext,
V1RuntimeContext runtimeContext,
V1MarkupParams markupParams,
V1InteractionParams interactionParams)
|
static V1PortletContext |
createPortletContext(String portletHandle)
portletHandle(xsd:string), portletState(xsd:base64Binary)?, extensions(
V1Extension)* |
static V1PortletContext |
createPortletContext(String portletHandle,
byte[] portletState) |
static V1PortletDescription |
createPortletDescription(org.gatein.pc.api.PortletContext portletContext,
List<V1MarkupType> markupTypes)
portletHandle(xsd:string), markupTypes(MarkupType)+, groupID(xsd:string)?, description(LocalizedString)?,
shortTitle(LocalizedString)?, title(LocalizedString)?, displayName(LocalizedString)?, keywords(LocalizedString)*,
userCategories(xsd:string)*, userProfileItems(xsd:string)*, usesMethodGet(xsd:boolean[false])?,
defaultMarkupSecure(xsd:boolean[false])?, onlySecure(xsd:boolean[false])?, userContextStoredInSession(xsd:boolean[false])?,
templatesStoredInSession(xsd:boolean[false])?, hasUserSpecificState(xsd:boolean[false])?,
doesUrlTemplateProcessing(xsd:boolean[false])?, extensions(Extension)*
|
static V1PortletDescription |
createPortletDescription(String portletHandle,
List<V1MarkupType> markupTypes) |
static V1PortletDescriptionResponse |
createPortletDescriptionResponse(V1PortletDescription portletDescription)
portletDescription(PortletDescription), resourceList(ResourceList)?, extensions(Extension)*
|
static V1PortletPropertyDescriptionResponse |
createPortletPropertyDescriptionResponse(List<V1PropertyDescription> propertyDescriptions)
modelDescription(ModelDescription)?, resourceList(ResourceList)?, extensions(Extension)*
|
static V1Property |
createProperty(String name,
String lang,
String stringValue)
( stringValue(xsd:string) | any* ), @name(xsd:string), @xml:lang
|
static V1PropertyDescription |
createPropertyDescription(String name,
QName type)
label(LocalizedString)?, hint(LocalizedString)?, extensions(Extension)*, @name(xsd:string), @type(xsd:QName)
|
static V1PropertyList |
createPropertyList()
properties(Property)*, resetProperties(ResetProperty)*, extensions(Extension)*
|
static V1RegistrationContext |
createRegistrationContext(String registrationHandle)
registrationHandle(xsd:string), registrationState(xsd:base64Binary)?, extensions(Extension)*
|
static V1RegistrationData |
createRegistrationData(String consumerName,
boolean methodGetSupported)
consumerName(xsd:string), consumerAgent(xsd:string), methodGetSupported(xsd:boolean), consumerModes(xsd:string)*,
consumerWindowStates(xsd:string)*, consumerUserScopes(xsd:string)*, customUserProfileData(xsd:string)*,
registrationProperties(Property)*, extensions(Extension)*
|
static V1ReleaseSessions |
createReleaseSessions(V1RegistrationContext registrationContext,
List<String> sessionIDs)
registrationContext(RegistrationContext)?, sessionIDs(xsd:string)*
|
static V1ResetProperty |
createResetProperty(String name)
EMPTY, @name(xsd:string)
|
static V1RuntimeContext |
createRuntimeContext(String userAuthentication,
String portletInstanceKey,
String namespacePrefix)
userAuthentication(xsd:string), portletInstanceKey(xsd:string)?, namespacePrefix(xsd:string)?,
templates(Templates)?, sessionID(xsd:string)?, extensions(Extension)*
|
static V1ServiceDescription |
createServiceDescription(boolean requiresRegistration)
requiresRegistration(xsd:boolean), offeredPortlets(PortletDescription)*, userCategoryDescriptions(ItemDescription)*,
customUserProfileItemDescriptions(ItemDescription)*, customWindowStateDescriptions(ItemDescription)*,
customModeDescriptions(ItemDescription)*, requiresInitCookie(CookieProtocol[none])?,
registrationPropertyDescription(ModelDescription)?, locales(xsd:string)*, resourceList(ResourceList)?,
extensions(Extension)*
|
static V1SessionContext |
createSessionContext(String sessionID,
int expires)
sessionID(xsd:string), expires(xsd:int), extensions(Extension)*
|
static V1SetPortletProperties |
createSetPortletProperties(V1RegistrationContext registrationContext,
V1PortletContext portletContext,
V1PropertyList propertyList)
registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?,
propertyList(PropertyList)
|
static V1ClonePortlet |
createSimpleClonePortlet(String portletHandle)
same as createClonePortlet(null, createPortletContext(portletHandle), null)
|
static V1GetPortletPropertyDescription |
createSimpleGetPortletPropertyDescription(String portletHandle)
Same as createGetPortletPropertyDescription(null, createPortletContext(portletHandle), null, null)
|
static V1Templates |
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 V1UpdateResponse |
createUpdateResponse()
sessionContext(SessionContext)?, portletContext(PortletContext)?, markupContext(MarkupContext)?,
navigationalState(xsd:string)? newWindowState(xsd:string)?, newMode(xsd:string)?
|
static V1UploadContext |
createUploadContext(String mimeType,
byte[] uploadData)
mimeType(xsd:string), uploadData(xsd:base64Binary), mimeAttributes(NamedString)*, extensions(Extension)*
|
static V1UserContext |
createUserContext(String userContextKey)
For UserProfile and related classes, everything is optional so no need to have factory methods.
|
public static V1GetServiceDescription createGetServiceDescription()
public static V1GetMarkup createMarkupRequest(V1PortletContext portletContext, V1RuntimeContext runtimeContext, V1MarkupParams markupParams)
portletContext - runtimeContext - markupParams - IllegalArgumentException - if one of the required parameters is nullpublic static V1PerformBlockingInteraction createPerformBlockingInteraction(V1PortletContext portletContext, V1RuntimeContext runtimeContext, V1MarkupParams markupParams, V1InteractionParams interactionParams)
V1RegistrationContext?, V1PortletContext, V1RuntimeContext, V1UserContext?,
V1MarkupParams, V1InteractionParamsportletContext - runtimeContext - markupParams - interactionParams - public static V1GetPortletDescription createGetPortletDescription(V1RegistrationContext registrationContext, String portletHandle)
registrationContext - portletHandle - handle for the PortletContextpublic static V1GetPortletDescription createGetPortletDescription(V1RegistrationContext registrationContext, org.gatein.pc.api.PortletContext portletContext)
registrationContext - portletContext - public static V1GetPortletProperties createGetPortletProperties(V1RegistrationContext registrationContext, V1PortletContext portletContext)
registrationContext - portletContext - public static V1BlockingInteractionResponse createBlockingInteractionResponse(V1UpdateResponse updateResponse)
public static V1BlockingInteractionResponse createBlockingInteractionResponse(String redirectURL)
public static V1UpdateResponse createUpdateResponse()
public static V1PortletDescription createPortletDescription(org.gatein.pc.api.PortletContext portletContext, List<V1MarkupType> markupTypes)
public static V1PortletDescription createPortletDescription(String portletHandle, List<V1MarkupType> markupTypes)
public static V1MarkupParams createDefaultMarkupParams()
WSRPConstants.getDefaultLocales(),
WSRPConstants.getDefaultMimeTypes(), WSRPConstants.VIEW_MODE,
WSRPConstants.NORMAL_WINDOW_STATE)public static V1MarkupParams createMarkupParams(boolean secureClientCommunication, List<String> locales, List<String> mimeTypes, String mode, String windowState)
V1ClientData)?, navigationalState(xsd:string)?,
markupCharacterSets(xsd:string)*, validateTag(xsd:string)?, validNewModes(xsd:string)*,
validNewWindowStates(xsd:string)*, extensions(V1Extension)*public static V1RuntimeContext createRuntimeContext(String userAuthentication, String portletInstanceKey, String namespacePrefix)
public static V1PortletContext createPortletContext(String portletHandle)
V1Extension)*portletHandle - public static V1PortletContext createPortletContext(String portletHandle, byte[] portletState)
portletHandle - portletState - public static V1InteractionParams createDefaultInteractionParams()
public static V1InteractionParams createInteractionParams(V1StateChange portletStateChange)
V1StateChange), interactionState(xsd:string)?, formParameters(NamedString)*,
uploadContexts(UploadContext)*, extensions(Extension)*public static V1InitCookie createInitCookie(V1RegistrationContext registrationContext)
registrationContext - public static V1ServiceDescription createServiceDescription(boolean requiresRegistration)
public static V1MarkupResponse createMarkupResponse(V1MarkupContext markupContext)
public static V1MarkupContext createMarkupContext(String mediaType, String markupString, byte[] markupBinary, Boolean useCacheItem)
public static V1SessionContext createSessionContext(String sessionID, int expires)
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.public static V1UserContext createUserContext(String userContextKey)
public static V1RegistrationData createRegistrationData(String consumerName, boolean methodGetSupported)
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".public static V1RegistrationData createDefaultRegistrationData()
WSRPConstants.DEFAULT_CONSUMER_NAME, false) using
WSRPConstants.CONSUMER_AGENT for the consumer agent.public static V1Property createProperty(String name, String lang, String stringValue)
public static V1Templates createTemplates(org.gatein.pc.api.spi.PortletInvocationContext context)
context - public static V1ClientData createClientData(String userAgent)
userAgent - public static V1CacheControl createCacheControl(int expires, String userScope)
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 - public static V1RegistrationContext createRegistrationContext(String registrationHandle)
registrationHandle - public static V1ModelDescription createModelDescription(List<V1PropertyDescription> propertyDescriptions)
public static V1PropertyDescription createPropertyDescription(String name, QName type)
public static V1LocalizedString createLocalizedString(String lang, String resourceName, String value)
public static V1LocalizedString createLocalizedString(String value)
value - public static V1PortletDescriptionResponse createPortletDescriptionResponse(V1PortletDescription portletDescription)
portletDescription - public static V1PortletPropertyDescriptionResponse createPortletPropertyDescriptionResponse(List<V1PropertyDescription> propertyDescriptions)
propertyDescriptions - public static V1GetPortletPropertyDescription createGetPortletPropertyDescription(V1RegistrationContext registrationContext, V1PortletContext portletContext, V1UserContext userContext, List<String> desiredLocales)
public static V1GetPortletPropertyDescription createSimpleGetPortletPropertyDescription(String portletHandle)
portletHandle - public static V1DestroyFailed createDestroyFailed(String portletHandle, String reason)
portletHandle - reason - public static V1DestroyPortletsResponse createDestroyPortletsResponse(List<V1DestroyFailed> destroyFailed)
destroyFailed - public static V1SetPortletProperties createSetPortletProperties(V1RegistrationContext registrationContext, V1PortletContext portletContext, V1PropertyList propertyList)
portletContext - propertyList - public static V1ClonePortlet createSimpleClonePortlet(String portletHandle)
portletHandle - public static V1ClonePortlet createClonePortlet(V1RegistrationContext registrationContext, V1PortletContext portletContext, V1UserContext userContext)
public static V1DestroyPortlets createDestroyPortlets(V1RegistrationContext registrationContext, List<String> portletHandles)
public static V1PropertyList createPropertyList()
public static V1ResetProperty createResetProperty(String name)
name - public static V1ReleaseSessions createReleaseSessions(V1RegistrationContext registrationContext, List<String> sessionIDs)
public static V1ModifyRegistration createModifyRegistration(V1RegistrationContext registrationContext, V1RegistrationData registrationData)
public static V1UploadContext createUploadContext(String mimeType, byte[] uploadData)
mimeType - uploadData - Copyright © 2006-2014 GateIn. All Rights Reserved.