Public PRT Api: Interface ISOAPMessageContext

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sapportals.portal.prt.service.soap
Interface ISOAPMessageContext

public interface ISOAPMessageContext

Context attached to a SOAPMessage, contains all the dat to un/marschall SOAP Message

Method Summary

void addDefaultValue(java.lang.String value)
          use it for pass the special parameters in the unmarshall /marshall method

void addMultirefValues(javax.xml.soap.SOAPBodyElement BodyElement)
          Add namespace element in context, use for process SOAP message with ref

java.lang.String addNamespaceDeclaration(java.lang.String uri)
          Add namespace declaration in context

void addNamespaceDeclaration(java.lang.String prefix, java.lang.String uri)
          Add declaration of namespace in the context

void addNamespaceDeclarationInElement(javax.xml.soap.SOAPElement element)
          Add declaration contains in a SOAP Element

void addNamespaceElementInContext(javax.xml.soap.SOAPElement element)
          Add namespace element in context

void addValueOfAttribute(java.lang.String value)
          use it for pass the special parameters in the unmarshall /marshall method

java.lang.String getArrayChildsName()
          return the last value of child name setting in the soap content

ISOAPMessageContext getChildSOAPMessageContext(ISOAPMessageContext contextparent, javax.xml.soap.SOAPElement item)
          Get Child SOAP message Context for SOAPElement

java.lang.String getDefaultValue()
          use it for pass the special parameters in the unmarshall /marshall method

java.lang.String getEncodingStyle()
          Get the encoding Style of the message

java.lang.String getEncodingStyleNotDelegate()
          Get EncodingStyle without delegating to parent context

java.lang.Object getFaultObjectInstance()
          specific for the fault process deserialization

javax.xml.soap.SOAPBodyElement getId(java.lang.String key)
          Get SOAPBodyElemtn from ID, use for process SOAP message with ref

MethodContainer getMethodContainer()
          Get the method container attached to this SOAPMessage

java.lang.String getNamespaceFromPrefix(java.lang.String prefix)
          Get the namespcace corresponding the prefix

java.util.Enumeration getPrefixes()
          Get all the prefix contain in the context

java.lang.String getPrefixForNamespace(java.lang.String namespace)
          Get prefix for namespace

java.lang.String getPrefixForNamespace(java.lang.String namespace, boolean isParent)
          Get prefix for namespace

IServiceDescriptor getServiceDescriptor()
          Get Service descriptor attached to the current context

java.lang.String getSOAPAction()
          return the soap action attribute link to the method called (extracted from the wsdl)

java.lang.String getTargetNamespaceMethod()
          return the the name space of the method (extracted from the wsdl)

java.lang.String getValueOfAttribute()
          FD : use it for pass the special parameters in the unmarshall /marshall method)

boolean isArrayList()
          return the type of array (specific for the document/literal)

boolean isDocumentStyleEncoding()


boolean isEncodedAsAttribute()
          use it for pass the special parameters in the unmarshall /marshall method

boolean isLitteralStyleEncoding()


java.lang.String isLitteralStyleEncodingAsked()


boolean isResponse()
          set to say that the current message is a response

boolean isSimpleTypeCurrentProcess()
          return if the current type is a simple type

void setArrayChildsName(java.lang.String name)
          set the name of array child for the Array De/serializer

void setArrayList(boolean value)
          set the type array list (doc/lit) fro the array enconding

void setEncodedAsAttribute(boolean value)
          use it for pass the special parameters in the unmarshall /marshall method

void setFaultObjectInstance(java.lang.Object exception)
          specific for the fault process desrialization

void setMethodContainer(MethodContainer container)
          Set the method container attached to this SOAPMessage

void setResponse(boolean flag)
          set the state of the response

void setSimpleTypeCurrentProcess(boolean value)
          set if the type currently de/serialized is a simpel type.

void setTargetNamespaceMethod(java.lang.String value)
          set the namespace of the method which call

Method Detail

getEncodingStyle

public java.lang.String getEncodingStyle()

Get the encoding Style of the message

Returns:

getNamespaceFromPrefix

public java.lang.String getNamespaceFromPrefix(java.lang.String prefix)

Get the namespcace corresponding the prefix

Parameters:: prefix - the prefix to find
Returns:: the namespace

addNamespaceDeclaration

public void addNamespaceDeclaration(java.lang.String prefix,
                                    java.lang.String uri)

Add declaration of namespace in the context

Parameters:: prefix - the prefix to add (key); uri - the namespace to add

addNamespaceDeclarationInElement

public void addNamespaceDeclarationInElement(javax.xml.soap.SOAPElement element)
                                      throws SOAPServiceException

Add declaration contains in a SOAP Element

Parameters:: element - the element containing the declaration
Throws:: SOAPServiceException -

getPrefixes

public java.util.Enumeration getPrefixes()

Get all the prefix contain in the context

Returns:: the list of prefix

getPrefixForNamespace

public java.lang.String getPrefixForNamespace(java.lang.String namespace)

Get prefix for namespace

Parameters:: namespace - namespace to find
Returns:: the prefix needed

getPrefixForNamespace

public java.lang.String getPrefixForNamespace(java.lang.String namespace,
                                              boolean isParent)

Get prefix for namespace

Parameters:: namespace - namespace to find
Returns:: the prefix needed

getServiceDescriptor

public IServiceDescriptor getServiceDescriptor()

Get Service descriptor attached to the current context

Returns:: the descriptor

getEncodingStyleNotDelegate

public java.lang.String getEncodingStyleNotDelegate()

Get EncodingStyle without delegating to parent context

Returns:: the encoding style

getId

public javax.xml.soap.SOAPBodyElement getId(java.lang.String key)

Get SOAPBodyElemtn from ID, use for process SOAP message with ref

Parameters:: key -
Returns:

addNamespaceElementInContext

public void addNamespaceElementInContext(javax.xml.soap.SOAPElement element)

Add namespace element in context

Parameters:: element - the element to add

addMultirefValues

public void addMultirefValues(javax.xml.soap.SOAPBodyElement BodyElement)

Add namespace element in context, use for process SOAP message with ref

Parameters:: BodyElementthe - bodyElement to add

addNamespaceDeclaration

public java.lang.String addNamespaceDeclaration(java.lang.String uri)

Add namespace declaration in context

Parameters:: uri - the namespace to add
Returns:: the namespace if already existing

getChildSOAPMessageContext

public ISOAPMessageContext getChildSOAPMessageContext(ISOAPMessageContext contextparent,
                                                      javax.xml.soap.SOAPElement item)

Get Child SOAP message Context for SOAPElement

Parameters:: contextparent - the parent context; item - the item corresponding to the context to find
Returns:: the found context

isDocumentStyleEncoding

public boolean isDocumentStyleEncoding()

Returns:: true if message is in Document Style

isLitteralStyleEncoding

public boolean isLitteralStyleEncoding()

Returns:: true if message is in Litteral Style (data extract from the soapconfig.xml)

isLitteralStyleEncodingAsked

public java.lang.String isLitteralStyleEncodingAsked()

Returns:: "true" if message is the message must be coded in Litteral Style (data extract from the request)

getValueOfAttribute

public java.lang.String getValueOfAttribute()

FD : use it for pass the special parameters in the unmarshall /marshall method)