public class OMOutputFormat extends Object
Setting of all the properties in a OMOutputFormat should be done before calling the getContentType() method. It is advised to set all the properties at the creation time of the OMOutputFormat and not to change them later.
Modifier and Type | Field and Description |
---|---|
static String |
ACTION_PROPERTY |
static String |
DEFAULT_CHAR_SET_ENCODING
Field DEFAULT_CHAR_SET_ENCODING.
|
static String |
RESPECT_SWA_ATTACHMENT_ORDER
Deprecated.
As of version 1.2.13, Axiom always respects the order of attachments.
|
static Boolean |
RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT
Deprecated.
As of version 1.2.13, Axiom always respects the order of attachments.
|
static String |
USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS |
Constructor and Description |
---|
OMOutputFormat() |
OMOutputFormat(OMOutputFormat format)
Constructs a new instance by copying the configuration from an existing instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
containsKey(String key) |
String |
getCharSetEncoding()
Returns the character set encoding scheme.
|
String |
getContentType()
Return the content-type value that should be written with the message.
|
String |
getContentTypeForMTOM(String SOAPContentType)
Generates a Content-Type value for MTOM messages.
|
String |
getContentTypeForSwA(String SOAPContentType) |
String |
getMimeBoundary() |
MultipartWriterFactory |
getMultipartWriterFactory()
Deprecated.
|
String |
getNextContentId() |
int |
getOptimizedThreshold() |
Object |
getProperty(String key) |
String |
getRootContentId() |
StAXWriterConfiguration |
getStAXWriterConfiguration()
Get the currently configured StAX writer configuration.
|
XMLStreamWriterFilter |
getXmlStreamWriterFilter() |
String |
getXmlVersion() |
boolean |
isAutoCloseWriter()
Deprecated.
|
boolean |
isDoingSWA()
Indicates whether the document should be serialized using SwA.
|
boolean |
isIgnoreXMLDeclaration() |
boolean |
isOptimized()
Indicates whether the document should be serialized using MTOM.
|
boolean |
isSOAP11() |
void |
setAutoCloseWriter(boolean autoCloseWriter)
Deprecated.
|
void |
setCharSetEncoding(String charSetEncoding) |
void |
setContentType(String c)
Set a raw content-type
(i.e.
|
void |
setDoingSWA(boolean doingSWA)
Specifies that the document should be serialized using SwA (SOAP with Attachments).
|
void |
setDoOptimize(boolean optimize)
Specifies that the document should be serialized using MTOM.
|
void |
setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration) |
void |
setMimeBoundary(String mimeBoundary) |
void |
setMultipartWriterFactory(MultipartWriterFactory multipartWriterFactory)
Deprecated.
|
void |
setOptimizedThreshold(int optimizedThreshold) |
Object |
setProperty(String key,
Object value) |
void |
setRootContentId(String rootContentId) |
void |
setSOAP11(boolean b) |
void |
setStAXWriterConfiguration(StAXWriterConfiguration writerConfiguration)
Set the StAX writer configuration that will be used when requesting an
XMLStreamWriter from StAXUtils . |
void |
setXmlStreamWriterFilter(XMLStreamWriterFilter xmlStreamWriterFilter) |
void |
setXmlVersion(String xmlVersion) |
String |
toString()
Use toString for logging state of the OMOutputFormat
|
public static final String DEFAULT_CHAR_SET_ENCODING
public static final String ACTION_PROPERTY
public static final String USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS
public static final String RESPECT_SWA_ATTACHMENT_ORDER
public static final Boolean RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT
public OMOutputFormat()
public OMOutputFormat(OMOutputFormat format)
format
- the existing instancepublic Object getProperty(String key)
key
- Stringpublic Object setProperty(String key, Object value)
key
- Stringvalue
- Objectpublic boolean containsKey(String key)
key
- public boolean isOptimized()
true
if the document should be serialized using MTOM; false
otherwise; the return value is always false
if isDoingSWA()
returns true
public String getContentType()
public void setContentType(String c)
c
- public String getMimeBoundary()
public String getRootContentId()
public String getNextContentId()
public String getCharSetEncoding()
public void setCharSetEncoding(String charSetEncoding)
public String getXmlVersion()
public void setXmlVersion(String xmlVersion)
public void setSOAP11(boolean b)
public boolean isSOAP11()
public boolean isIgnoreXMLDeclaration()
public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)
public void setDoOptimize(boolean optimize)
setDoingSWA(boolean)
.optimize
- true
if the document should be serialized using MTOM;
false
otherwisepublic boolean isDoingSWA()
true
if the document should be serialized using SwA; false
otherwisepublic void setDoingSWA(boolean doingSWA)
setDoOptimize(boolean)
is ignored.doingSWA
- true
if the document should be serialized using SwA;
false
otherwisepublic String getContentTypeForMTOM(String SOAPContentType)
SOAPContentType
- public boolean isAutoCloseWriter()
public void setAutoCloseWriter(boolean autoCloseWriter)
public void setMimeBoundary(String mimeBoundary)
public void setRootContentId(String rootContentId)
public String toString()
public void setOptimizedThreshold(int optimizedThreshold)
public int getOptimizedThreshold()
public XMLStreamWriterFilter getXmlStreamWriterFilter()
public void setXmlStreamWriterFilter(XMLStreamWriterFilter xmlStreamWriterFilter)
xmlStreamWriterFilter
- the xmlStreamWriterFilter to setpublic StAXWriterConfiguration getStAXWriterConfiguration()
StAXWriterConfiguration.DEFAULT
if none has been
set explicitlypublic void setStAXWriterConfiguration(StAXWriterConfiguration writerConfiguration)
XMLStreamWriter
from StAXUtils
.writerConfiguration
- the configurationpublic MultipartWriterFactory getMultipartWriterFactory()
AxiomMultipartWriterFactory
instance is returnedpublic void setMultipartWriterFactory(MultipartWriterFactory multipartWriterFactory)
multipartWriterFactory
- the factoryCopyright © The Apache Software Foundation. All Rights Reserved.