Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | 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(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
 String addNamespaceDeclaration(String uri)
          Add namespace declaration in context
 void addNamespaceDeclaration(String prefix, 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(String value)
          use it for pass the special parameters in the unmarshall /marshall method
 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
 String getDefaultValue()
          use it for pass the special parameters in the unmarshall /marshall method
 String getEncodingStyle()
          Get the encoding Style of the message
 String getEncodingStyleNotDelegate()
          Get EncodingStyle without delegating to parent context
 Object getFaultObjectInstance()
          specific for the fault process deserialization
 javax.xml.soap.SOAPBodyElement getId(String key)
          Get SOAPBodyElemtn from ID, use for process SOAP message with ref
 MethodContainer getMethodContainer()
          Get the method container attached to this SOAPMessage
 String getNamespaceFromPrefix(String prefix)
          Get the namespcace corresponding the prefix
 Enumeration getPrefixes()
          Get all the prefix contain in the context
 String getPrefixForNamespace(String namespace)
          Get prefix for namespace
 String getPrefixForNamespace(String namespace, boolean isParent)
          Get prefix for namespace
 IServiceDescriptor getServiceDescriptor()
          Get Service descriptor attached to the current context
 String getSOAPAction()
          return the soap action attribute link to the method called (extracted from the wsdl)
 String getTargetNamespaceMethod()
          return the the name space of the method (extracted from the wsdl)
 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()
           
 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(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(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(String value)
          set the namespace of the method which call
 

Method Detail

getEncodingStyle

public String getEncodingStyle()
Get the encoding Style of the message

Returns:

getNamespaceFromPrefix

public String getNamespaceFromPrefix(String prefix)
Get the namespcace corresponding the prefix

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

addNamespaceDeclaration

public void addNamespaceDeclaration(String prefix,
                                    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 Enumeration getPrefixes()
Get all the prefix contain in the context

Returns:
the list of prefix

getPrefixForNamespace

public String getPrefixForNamespace(String namespace)
Get prefix for namespace

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

getPrefixForNamespace

public String getPrefixForNamespace(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 String getEncodingStyleNotDelegate()
Get EncodingStyle without delegating to parent context

Returns:
the encoding style

getId

public javax.xml.soap.SOAPBodyElement getId(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

addNamespaceDeclaration

public String addNamespaceDeclaration(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 String isLitteralStyleEncodingAsked()
Returns:
"true" if message is the message must be coded in Litteral Style (data extract from the request)

getValueOfAttribute

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

isEncodedAsAttribute

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

Returns:

setEncodedAsAttribute

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

Parameters:
value -

getDefaultValue

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

Returns:

addValueOfAttribute

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

Parameters:
value -

addDefaultValue

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

Parameters:
value -

isResponse

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

Returns:
yes if response, false else

setResponse

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

Parameters:
flag - the state

getFaultObjectInstance

public Object getFaultObjectInstance()
specific for the fault process deserialization

Returns:
PRTFault object

setFaultObjectInstance

public void setFaultObjectInstance(Object exception)
specific for the fault process desrialization

Parameters:
exception - the exception to store

setMethodContainer

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

Parameters:
container -

getMethodContainer

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

Returns:
the Method Container

getSOAPAction

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

Returns:
can be null

getTargetNamespaceMethod

public String getTargetNamespaceMethod()
return the the name space of the method (extracted from the wsdl)

Returns:
can be null

setTargetNamespaceMethod

public void setTargetNamespaceMethod(String value)
set the namespace of the method which call

Parameters:
value - cannot be null

getArrayChildsName

public String getArrayChildsName()
return the last value of child name setting in the soap content

Returns:
null can be return

setArrayChildsName

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

Parameters:
name - can be null

isArrayList

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

Returns:

setArrayList

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

Parameters:
value -

isSimpleTypeCurrentProcess

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

Returns:
true if a simple type (restriction , extends, etc..)

setSimpleTypeCurrentProcess

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

Returns:
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.