当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

WSRPTypeFactory - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.wsrp
Class WSRPTypeFactory

java.lang.Object
  org.jboss.portal.wsrp.WSRPTypeFactory

---

public class WSRPTypeFactory

extends java.lang.Object

Creates minimally valid instances of WSRP types, populated with default values where possible, as per wsrp_v1_types.xsd. See JBPORTAL-808 for more information.

Since:

2.4

Version:

$Revision: 5440 $

Author:

Chris Laprun

---

Field Summary
private static ActionURL	ACTION_URL
private static RenderURL	RENDER_URL

 

Constructor Summary

WSRPTypeFactory()

 

Method Summary
private static void	checkPortletHandle(java.lang.String portletHandle)
static BlockingInteractionResponse	createBlockingInteractionResponse(UpdateResponse updateResponse)           ( updateResponse(UpdateResponse) | redirectURL(xsd:string) ), extensions(Extension)*
static CacheControl	createCacheControl(int expires, java.lang.String userScope)           expires(xsd:int), userScope(xsd:string), validateTag(xsd:string)?, extensions(Extension)*
static ClientData	createClientData(java.lang.String userAgent)           userAgent(xsd:string)?, extensions(Extension)*
static InteractionParams	createDefaultInteractionParams()           Same as createInteractionParams(StateChange.readOnly)
static MarkupParams	createDefaultMarkupParams()           Same as createMarkupParams(false, WSRPConstants.DEFAULT_LOCALES, WSRPConstants.DEFAULT_MIME_TYPES, WSRPConstants.VIEW_MODE, WSRPConstants.NORMAL_WINDOW_STATE)
static GetMarkup	createDefaultMarkupRequest(java.lang.String handle)           Same as createMarkupRequest(handle, createDefaultRuntimeContext(), createDefaultMarkupParams())
static PerformBlockingInteraction	createDefaultPerformBlockingInteraction(java.lang.String portletHandle)           Same as createPerformBlockingInteraction(portletHandle, createDefaultRuntimeContext()(), createDefaultMarkupParams()(), createDefaultInteractionParams()());
static RuntimeContext	createDefaultRuntimeContext()           Same as createRuntimeContext(WSRPConstants.NONE_USER_AUTHENTICATION)
static GetPortletDescription	createGetPortletDescription(RegistrationContext registrationContext, java.lang.String portletHandle)           registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*
static GetPortletProperties	createGetPortletProperties(RegistrationContext registrationContext, java.lang.String portletHandle)           registrationContext(RegistrationContext)?, portletContext(PortletContext), userContext(UserContext)?, desiredLocales(xsd:string)*
static GetServiceDescription	createGetServiceDescription()           registrationContext(RegistrationContext)?, desiredLocales(xsd:string)*
static InitCookie	createInitCookie(RegistrationContext registrationContext)           registrationContext(RegistrationContext)?
static InteractionParams	createInteractionParams(StateChange portletStateChange)           portletStateChange(StateChange), interactionState(xsd:string)?, formParameters(NamedString)*, uploadContexts(UploadContext)*, extensions(Extension)*
static MarkupContext	createMarkupContext(java.lang.String mimeType, byte[] markupBinary)           useCachedMarkup(xsd:boolean[false])?, mimeType(xsd:string)?, (markupString(xsd:string) | markupBinary(xsd:base64Binary)), locale(xsd:string)?, requiresUrlRewriting(xsd:boolean[false])?, cacheControl(CacheControl)?, preferredTitle(xsd:string)?, extensions(Extension)*
static MarkupContext	createMarkupContext(java.lang.String mimeType, java.lang.String markupString)           mimeType: The mime type of the returned markup.
static MarkupParams	createMarkupParams(boolean secureClientCommunication, java.lang.String[] locales, java.lang.String[] mimeTypes, java.lang.String mode, java.lang.String windowState)           secureClientCommunication(xsd:boolean), locales(xsd:string)+, mimeTypes(xsd:string)+, mode(xsd:string), windowState(xsd:string), clientData(org.jboss.portal.wsrp.core.ClientData)?, navigationalState(xsd:string)?, markupCharacterSets(xsd:string)*, validateTag(xsd:string)?, validNewModes(xsd:string)*, validNewWindowStates(xsd:string)*, extensions(org.jboss.portal.wsrp.core.Extension)*
static GetMarkup	createMarkupRequest(java.lang.String handle, RuntimeContext runtimeContext, MarkupParams markupParams)           registrationContext(RegistrationContext)?, portletContext(PortletContext), runtimeContext(RuntimeContext), userContext(UserContext)?, markupParams(MarkupParams)
static MarkupResponse	createMarkupResponse(MarkupContext markupContext)           markupContext(MarkupContext), sessionContext(SessionContext)?, extensions(Extension)*
static PerformBlockingInteraction	createPerformBlockingInteraction(java.lang.String portletHandle, RuntimeContext runtimeContext, MarkupParams markupParams, InteractionParams interactionParams)           org.jboss.portal.wsrp.core.RegistrationContext?, PortletContext, RuntimeContext, org.jboss.portal.wsrp.core.UserContext?, MarkupParams, InteractionParams
static PortletContext	createPortletContext(java.lang.String portletHandle)           portletHandle(xsd:string), portletState(xsd:base64Binary)?, extensions(org.jboss.portal.wsrp.core.Extension)*
static PortletDescription	createPortletDescription(java.lang.String portletHandle, MarkupType[] 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 Property	createProperty(java.lang.String name, java.lang.String lang, java.lang.String stringValue)           ( stringValue(xsd:string) | any* ), @name(xsd:string), @xml:lang
static RegistrationData	createRegistrationData(java.lang.String consumerName, java.lang.String consumerAgent, 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 RuntimeContext	createRuntimeContext(java.lang.String userAuthentication)           userAuthentication(xsd:string), portletInstanceKey(xsd:string)?, namespacePrefix(xsd:string)?, templates(Templates)?, sessionID(xsd:string)?, extensions(Extension)*
static ServiceDescription	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 SessionContext	createSessionContext(java.lang.String sessionID, int expires)           sessionID(xsd:string), expires(xsd:int), extensions(Extension)*
private static java.lang.String	createTemplate(PortletInvocationContext context, PortletURL url, java.lang.Boolean secure)
static Templates	createTemplates(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 UpdateResponse	createUpdateResponse()           sessionContext(SessionContext)?, portletContext(PortletContext)?, markupContext(MarkupContext)?, navigationalState(xsd:string)? newWindowState(xsd:string)?, newMode(xsd:string)?
static UserContext	createUserContext(java.lang.String userContextKey)           For UserProfile and related classes, everything is optional so no need to have factory methods.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

ACTION_URL

private static final ActionURL ACTION_URL

---

RENDER_URL

private static final RenderURL RENDER_URL

Constructor Detail

WSRPTypeFactory

public WSRPTypeFactory()

Method Detail

createGetServiceDescription

public static GetServiceDescription createGetServiceDescription()

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

Returns:

---

createDefaultMarkupRequest

public static GetMarkup createDefaultMarkupRequest(java.lang.String handle)

Same as createMarkupRequest(handle, createDefaultRuntimeContext(), createDefaultMarkupParams())

Parameters:

handle -

Returns:

---

createMarkupRequest

public static GetMarkup createMarkupRequest(java.lang.String handle,
                                            RuntimeContext runtimeContext,
                                            MarkupParams markupParams)

registrationContext(RegistrationContext)?, portletContext(PortletContext), runtimeContext(RuntimeContext), userContext(UserContext)?, markupParams(MarkupParams)

Parameters:

handle -

runtimeContext -

markupParams -

Returns:

Throws:

java.lang.IllegalArgumentException - if one of the required parameters is null

---

createDefaultPerformBlockingInteraction

public static PerformBlockingInteraction createDefaultPerformBlockingInteraction(java.lang.String portletHandle)

Same as createPerformBlockingInteraction(portletHandle, createDefaultRuntimeContext()(), createDefaultMarkupParams()(), createDefaultInteractionParams()());

Parameters:

portletHandle -

Returns:

---

createPerformBlockingInteraction

public static PerformBlockingInteraction createPerformBlockingInteraction(java.lang.String portletHandle,
                                                                          RuntimeContext runtimeContext,
                                                                          MarkupParams markupParams,
                                                                          InteractionParams interactionParams)

org.jboss.portal.wsrp.core.RegistrationContext?, PortletContext, RuntimeContext, org.jboss.portal.wsrp.core.UserContext?, MarkupParams, InteractionParams

Parameters:

portletHandle -

runtimeContext -

markupParams -

interactionParams -

Returns:

---

createGetPortletDescription

public static GetPortletDescription createGetPortletDescription(RegistrationContext registrationContext,
                                                                java.lang.String portletHandle)

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

Parameters:

registrationContext -

portletHandle - handle for the PortletContext

Returns:

Since:

2.4.1

---

createGetPortletProperties

public static GetPortletProperties createGetPortletProperties(RegistrationContext registrationContext,
                                                              java.lang.String portletHandle)

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

Parameters:

registrationContext -

portletHandle -

Returns:

Since:

2.6

---

createBlockingInteractionResponse

public static BlockingInteractionResponse createBlockingInteractionResponse(UpdateResponse updateResponse)

( updateResponse(UpdateResponse) | redirectURL(xsd:string) ), extensions(Extension)*

Returns:

---

createUpdateResponse

public static UpdateResponse createUpdateResponse()

sessionContext(SessionContext)?, portletContext(PortletContext)?, markupContext(MarkupContext)?, navigationalState(xsd:string)? newWindowState(xsd:string)?, newMode(xsd:string)?

Returns:

---

createPortletDescription

public static PortletDescription createPortletDescription(java.lang.String portletHandle,
                                                          MarkupType[] 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)*

Returns:

---

checkPortletHandle

private static void checkPortletHandle(java.lang.String portletHandle)

---

createDefaultMarkupParams

public static MarkupParams createDefaultMarkupParams()

Same as createMarkupParams(false, WSRPConstants.DEFAULT_LOCALES, WSRPConstants.DEFAULT_MIME_TYPES, WSRPConstants.VIEW_MODE, WSRPConstants.NORMAL_WINDOW_STATE)

Returns:

---

createMarkupParams

public static MarkupParams createMarkupParams(boolean secureClientCommunication,
                                              java.lang.String[] locales,
                                              java.lang.String[] mimeTypes,
                                              java.lang.String mode,
                                              java.lang.String windowState)

secureClientCommunication(xsd:boolean), locales(xsd:string)+, mimeTypes(xsd:string)+, mode(xsd:string), windowState(xsd:string), clientData(org.jboss.portal.wsrp.core.ClientData)?, navigationalState(xsd:string)?, markupCharacterSets(xsd:string)*, validateTag(xsd:string)?, validNewModes(xsd:string)*, validNewWindowStates(xsd:string)*, extensions(org.jboss.portal.wsrp.core.Extension)*

Returns:

---

createDefaultRuntimeContext

public static RuntimeContext createDefaultRuntimeContext()

Same as createRuntimeContext(WSRPConstants.NONE_USER_AUTHENTICATION)

Returns:

---

createRuntimeContext

public static RuntimeContext createRuntimeContext(java.lang.String userAuthentication)

userAuthentication(xsd:string), portletInstanceKey(xsd:string)?, namespacePrefix(xsd:string)?, templates(Templates)?, sessionID(xsd:string)?, extensions(Extension)*

Returns:

---

createPortletContext

public static PortletContext createPortletContext(java.lang.String portletHandle)

portletHandle(xsd:string), portletState(xsd:base64Binary)?, extensions(org.jboss.portal.wsrp.core.Extension)*

Parameters:

portletHandle -

Returns:

---

createDefaultInteractionParams

public static InteractionParams createDefaultInteractionParams()

Same as createInteractionParams(StateChange.readOnly)

Returns:

---

createInteractionParams

public static InteractionParams createInteractionParams(StateChange portletStateChange)

portletStateChange(StateChange), interactionState(xsd:string)?, formParameters(NamedString)*, uploadContexts(UploadContext)*, extensions(Extension)*

Returns:

---

createInitCookie

public static InitCookie createInitCookie(RegistrationContext registrationContext)

registrationContext(RegistrationContext)?

Parameters:

registrationContext -

Returns:

---

createServiceDescription

public static ServiceDescription 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)*

Returns:

---

createMarkupResponse

public static MarkupResponse createMarkupResponse(MarkupContext markupContext)

markupContext(MarkupContext), sessionContext(SessionContext)?, extensions(Extension)*

Returns:

---

createMarkupContext

public static MarkupContext createMarkupContext(java.lang.String mimeType,
                                                java.lang.String markupString)

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.

useCachedMarkup(xsd:boolean[false])?, mimeType(xsd:string)?, (markupString(xsd:string) | markupBinary(xsd:base64Binary)), locale(xsd:string)?, requiresUrlRewriting(xsd:boolean[false])?, cacheControl(CacheControl)?, preferredTitle(xsd:string)?, extensions(Extension)*

Returns:

---

createMarkupContext

public static MarkupContext createMarkupContext(java.lang.String mimeType,
                                                byte[] markupBinary)

useCachedMarkup(xsd:boolean[false])?, mimeType(xsd:string)?, (markupString(xsd:string) | markupBinary(xsd:base64Binary)), locale(xsd:string)?, requiresUrlRewriting(xsd:boolean[false])?, cacheControl(CacheControl)?, preferredTitle(xsd:string)?, extensions(Extension)*

Parameters:

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.

Returns:

a new MarkupContext

---

createSessionContext

public static SessionContext createSessionContext(java.lang.String sessionID,
                                                  int expires)

sessionID(xsd:string), expires(xsd:int), extensions(Extension)*

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(java.lang.String userContextKey)

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

userContextKey(xsd:string), userCategories(xsd:string)*, profile(UserProfile)?, extensions(Extension)*

Returns:

---

createRegistrationData

public static RegistrationData createRegistrationData(java.lang.String consumerName,
                                                      java.lang.String consumerAgent,
                                                      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)*

Parameters:

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

consumerAgent - Name and version of the Consumer's vendor [R356]. The consumerAgent value MUST start with "productName.majorVersion.minorVersion" where "productName" identifies the product the Consumer installed for its deployment, and majorVersion and minorVersion are vendor-defined indications of the version of its product. This string can then contain any additional characters/words the product or Consumer wish to supply.

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:

---

createProperty

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

( stringValue(xsd:string) | any* ), @name(xsd:string), @xml:lang

Returns:

---

createTemplates

public static Templates createTemplates(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:

---

createTemplate

private static java.lang.String createTemplate(PortletInvocationContext context,
                                               PortletURL url,
                                               java.lang.Boolean secure)

---

createClientData

public static ClientData createClientData(java.lang.String userAgent)

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

Parameters:

userAgent -

Returns:

---

createCacheControl

public static CacheControl createCacheControl(int expires,
                                              java.lang.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:

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---