org.apache.wsrp4j.util
Class ParameterChecker

java.lang.Object
  org.apache.wsrp4j.util.ParameterChecker

public class ParameterChecker

extends java.lang.Object

This class validates the objects and their attributes used for the WSRP communication requests. The object and attribute tree is scanned including the 2nd level. This means, that the input object, it's attributes and ,if the attribute is itself an object, the subsequent object and It's attributes are also checked. The checking is done only for required (R) parameters in the WSRP specification. Optional (O) parameters are ignored. If a parameter is specified as 'nillable' in the WSRP specification, the check is performed if the value is 'not null'. On null value, no checking is done.

Constructor Summary

ParameterChecker()
Default Constructor

Method Summary

void	check(BlockingInteractionResponse response) Parameter check for the BlockingInteractionResponse object.
void	check(ClonePortlet request) Parameter check for the ClonePortlet object.
void	check(DestroyPortlets request) Parameter check for the DestroyEntites object.
void	check(DestroyPortletsResponse response) Validates the DestroyPortletsResponse object 1) DestroyFailed[], only if available
void	check(GetMarkup request) Check the GetMarkup.
void	check(GetPortletDescription request) Parameter check for the GetPortletDescription object.
void	check(GetPortletProperties request) Parameter check for the SetPortletProperties object.
void	check(GetPortletPropertyDescription request) Parameter check for the SetPortletProperties object.
void	check(GetServiceDescription request) Check the GetServiceDescritpion.
void	check(InitCookie request) Check the InitCookie.
void	check(MarkupResponse response) Parameter check for the MarkupResponse object.
void	check(ModifyRegistration request) Check the ModifyRegistration.
void	check(PerformBlockingInteraction request) Check the PerformBlockingInteraction.
void	check(PortletContext portletContext, boolean nillable) Check the PortletContext.
void	check(PortletDescription element) Parameter check for the PortletDescription object.
void	check(PortletDescriptionResponse response) Validates the PortletDescriptionResponse object 1) PortletDescription 2) ResourceList, only if available
void	check(PortletPropertyDescriptionResponse response) Validates the PortletPropertyDescriptionResponse object 1) ResourceList
void	check(PropertyList propertyList, boolean nillable) Check the PropertyList.
void	check(RegistrationContext registrationContext, boolean nillable) Check the RegistrationContext.
void	check(RegistrationData registrationData, boolean nillable) Check the RegistrationData.
void	check(ReleaseSessions request) Parameter check for the ReleaseSession object.
void	check(ServiceDescription response) Parameter check for the ServiceDescription object.
void	check(SetPortletProperties request) Parameter check for the SetPortletProperties object.
void	check(Templates element) Parameter check for the PortletDescription object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterChecker

public ParameterChecker()

Default Constructor

Method Detail

check

public void check(GetServiceDescription request)
           throws MissingParametersFault

Check the GetServiceDescritpion. The following attributes are mandatory: 1) RegistrationContext, only if available 2) String[] DesiredLocales, only if SendAllLocales == false

Parameters:

request - _getServiceDescription

Throws:

MissingParametersFault

See Also:

GetServiceDescription

check

public void check(ModifyRegistration request)
           throws MissingParametersFault

Check the ModifyRegistration. The following attributes are mandatory: 1) RegistrationContext, only if available 2) RegistrationData

Parameters:

request - _modifyRegistration

Throws:

MissingParametersFault

See Also:

ModifyRegistration

check

public void check(GetMarkup request)
           throws MissingParametersFault

Check the GetMarkup. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) RuntimeContext 4) UserContext, only if available 5) MarkupParams

Parameters:

request - getMarkup

Throws:

MissingParametersFault

See Also:

GetMarkup

check

public void check(PerformBlockingInteraction request)
           throws MissingParametersFault

Check the PerformBlockingInteraction. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) RuntimeContext 4) UserContext, only if available 5) MarkupParams 6) InteractionParams

Parameters:

request - _performBlockingInteraction

Throws:

MissingParametersFault

See Also:

PerformBlockingInteraction

check

public void check(InitCookie request)
           throws MissingParametersFault

Check the InitCookie. The following attributes are mandatory: 1) RegistrationContext, only if available

Parameters:

request - _initCookie

Throws:

MissingParametersFault

See Also:

InitCookie

check

public void check(GetPortletDescription request)
           throws MissingParametersFault

Parameter check for the GetPortletDescription object. The following attributes are mandatory 1) RegistrationContext, only if available 2) PortletContext 3) UserContext, only if available

Parameters:

request - _getPortletDescription

Throws:

MissingParametersFault

See Also:

GetPortletDescription

check

public void check(ClonePortlet request)
           throws MissingParametersFault

Parameter check for the ClonePortlet object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) UserContext, only if available

Parameters:

request - _clonePortlet

Throws:

MissingParametersFault

See Also:

ClonePortlet

check

public void check(DestroyPortlets request)
           throws MissingParametersFault

Parameter check for the DestroyEntites object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletHandle

Parameters:

request - _destroyPortlets

Throws:

MissingParametersFault

See Also:

DestroyPortlets

check

public void check(SetPortletProperties request)
           throws MissingParametersFault

Parameter check for the SetPortletProperties object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) UserContext, only if available 4) PropertyList

Parameters:

request - _setPortletProperties

Throws:

MissingParametersFault

See Also:

SetPortletProperties

check

public void check(GetPortletProperties request)
           throws MissingParametersFault

Parameter check for the SetPortletProperties object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) UserContext, only if available 4) Names, only if available

Parameters:

request - _getPortletProperties

Throws:

MissingParametersFault

See Also:

GetPortletPorperties

check

public void check(GetPortletPropertyDescription request)
           throws MissingParametersFault

Parameter check for the SetPortletProperties object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) PortletContext 3) UserContext, only if available

Parameters:

request - _getPortletPropertyDescription

Throws:

MissingParametersFault

See Also:

GetPortletPropertyDescription

check

public void check(ReleaseSessions request)
           throws MissingParametersFault

Parameter check for the ReleaseSession object. The following attributes are mandatory: 1) RegistrationContext, only if available 2) String[] SessionHandles

Parameters:

request - _releaseSession

Throws:

MissingParametersFault

See Also:

ReleaseSession

check

public void check(ServiceDescription response)
           throws MissingParametersFault

Parameter check for the ServiceDescription object. The following attribute needs to be set: - requiresRegistration

Parameters:

response - ServiceDescription

Throws:

MissingParametersFault

See Also:

ServiceDescription

check

public void check(BlockingInteractionResponse response)
           throws MissingParametersFault

Parameter check for the BlockingInteractionResponse object. The following attribute needs to be set: either - updateResponse or - redirectURL

Parameters:

response - BlockingInteractionResponse

Throws:

MissingParametersFault

See Also:

BlockingInteractionResponse

check

public void check(MarkupResponse response)
           throws MissingParametersFault

Parameter check for the MarkupResponse object. The following attribute needs to be set: 1) MarkupContext 2) SessionContext, only if available

Parameters:

response - MarkupResponse

Throws:

MissingParametersFault

See Also:

MarkupResponse

check

public void check(PortletDescriptionResponse response)
           throws MissingParametersFault

Validates the PortletDescriptionResponse object 1) PortletDescription 2) ResourceList, only if available

Parameters:

response - PortletDescriptionResponse

Throws:

MissingParametersFault

See Also:

PortletDescriptionResponse

check

public void check(PortletPropertyDescriptionResponse response)
           throws MissingParametersFault

Validates the PortletPropertyDescriptionResponse object 1) ResourceList

Parameters:

response - PortletPropertyDescriptionResponse

Throws:

MissingParametersFault

See Also:

PortletPropertyDescriptionResponse

check

public void check(DestroyPortletsResponse response)
           throws MissingParametersFault

Validates the DestroyPortletsResponse object 1) DestroyFailed[], only if available

Parameters:

response - DestroyPortletResponse

Throws:

MissingParametersFault

See Also:

DestroyPortletsResponse

check

public void check(PortletDescription element)
           throws MissingParametersFault

Parameter check for the PortletDescription object. The following parameter needs to be set: 1) portletHandle 2) markupType[]

Parameters:

element - PortletDescription

Throws:

MissingParametersFault

See Also:

PortletDescription

check

public void check(Templates element)
           throws MissingParametersFault

Parameter check for the PortletDescription object. The following parameter needs to be set: all templates...

Parameters:

element - Templates

Throws:

MissingParametersFault

See Also:

PortletDescription

check

public void check(PropertyList propertyList,
                  boolean nillable)
           throws MissingParametersFault

Check the PropertyList. The following attributes are mandatory: 1) Property[]

Parameters:

propertyList - PropertyList

nillable - boolean true, if the PropertyList can be nill false, if the PropertyList is not nillable

Throws:

MissingParametersFault

See Also:

PropertyList

check

public void check(RegistrationData registrationData,
                  boolean nillable)
           throws MissingParametersFault

Check the RegistrationData. The following attributes are mandatory: 1) ConsumerName 2) ConsumerAgent

Parameters:

registrationData - RegistrationData

nillable - boolean true, if the RegistrationData can be nill false, if the RegistrationData is not nillable

Throws:

MissingParametersFault

See Also:

RegistrationData

check

public void check(RegistrationContext registrationContext,
                  boolean nillable)
           throws MissingParametersFault

Check the RegistrationContext. The following attributes are mandatory: 1) RegistrationHandle

Parameters:

registrationContext - RegistrationContext

nillable - boolean true, if the RegistrationContext can be nill false, if the RegistrationContext is not nillable

Throws:

MissingParametersFault

See Also:

RegistrationContext

check

public void check(PortletContext portletContext,
                  boolean nillable)
           throws MissingParametersFault

Check the PortletContext. The following attributes are mandatory: 1) PortletHandle

Parameters:

portletContext - PortletContext

nillable - boolean true, if the PortletContext can be nill false, if the PortletContext is not nillable

Throws:

MissingParametersFault

See Also:

PortletContext