OMOutputFormat

java.lang.Object
- org.apache.axiom.om.OMOutputFormat

```
public class OMOutputFormat
extends java.lang.Object
```
Formats options for OM Output.
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.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_PROPERTY`
`private boolean`	`autoCloseWriter`
`private java.lang.String`	`charSetEncoding`
`private java.lang.String`	`contentType`
`private boolean`	`contentTypeSet` Flag set if `contentType` has been set explicitly through `setContentType(String)`.
`static java.lang.String`	`DEFAULT_CHAR_SET_ENCODING` Field DEFAULT_CHAR_SET_ENCODING.
`private boolean`	`doingSWA`
`private boolean`	`doOptimize`
`private boolean`	`ignoreXMLDeclaration`
`private boolean`	`isSoap11`
`private static org.apache.commons.logging.Log`	`log`
`private java.util.HashMap`	`map`
`private java.lang.String`	`mimeBoundary`
`private MultipartWriterFactory`	`multipartWriterFactory`
`private int`	`nextid`
`private int`	`optimizedThreshold`
`static java.lang.String`	`RESPECT_SWA_ATTACHMENT_ORDER` Deprecated. As of version 1.2.13, Axiom always respects the order of attachments.
`static java.lang.Boolean`	`RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT` Deprecated. As of version 1.2.13, Axiom always respects the order of attachments.
`private java.lang.String`	`rootContentId`
`static java.lang.String`	`USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS`
`private StAXWriterConfiguration`	`writerConfiguration`
`private XMLStreamWriterFilter`	`xmlStreamWriterFilter`
`private java.lang.String`	`xmlVersion`

Constructor Summary

Constructors
Constructor and Description

OMOutputFormat()

OMOutputFormat(OMOutputFormat format)
Constructs a new instance by copying the configuration from an existing instance.

Constructors
Constructor and Description
`OMOutputFormat()`
`OMOutputFormat(OMOutputFormat format)` Constructs a new instance by copying the configuration from an existing instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsKey(java.lang.String key)`
`java.lang.String`	`getCharSetEncoding()` Returns the character set encoding scheme.
`java.lang.String`	`getContentType()` Return the content-type value that should be written with the message.
`java.lang.String`	`getContentTypeForMTOM(java.lang.String SOAPContentType)` Generates a Content-Type value for MTOM messages.
`java.lang.String`	`getContentTypeForSwA(java.lang.String SOAPContentType)`
`java.lang.String`	`getMimeBoundary()`
`MultipartWriterFactory`	`getMultipartWriterFactory()` Get the currently configured multipart writer factory.
`java.lang.String`	`getNextContentId()`
`int`	`getOptimizedThreshold()`
`java.lang.Object`	`getProperty(java.lang.String key)`
`java.lang.String`	`getRootContentId()`
`StAXWriterConfiguration`	`getStAXWriterConfiguration()` Get the currently configured StAX writer configuration.
`XMLStreamWriterFilter`	`getXmlStreamWriterFilter()`
`java.lang.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(java.lang.String charSetEncoding)`
`void`	`setContentType(java.lang.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(java.lang.String mimeBoundary)`
`void`	`setMultipartWriterFactory(MultipartWriterFactory multipartWriterFactory)` Set the multipart writer factory.
`void`	`setOptimizedThreshold(int optimizedThreshold)`
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.Object value)`
`void`	`setRootContentId(java.lang.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(java.lang.String xmlVersion)`
`java.lang.String`	`toString()` Use toString for logging state of the OMOutputFormat

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
private static final org.apache.commons.logging.Log log
```
  - mimeBoundary
```
private java.lang.String mimeBoundary
```
  - rootContentId
```
private java.lang.String rootContentId
```
  - nextid
```
private int nextid
```
  - doOptimize
```
private boolean doOptimize
```
  - doingSWA
```
private boolean doingSWA
```
  - isSoap11
```
private boolean isSoap11
```
  - optimizedThreshold
```
private int optimizedThreshold
```
  - DEFAULT_CHAR_SET_ENCODING
```
public static final java.lang.String DEFAULT_CHAR_SET_ENCODING
```
    Field DEFAULT_CHAR_SET_ENCODING. Specifies the default character encoding scheme to be used.
    
    See Also:
    
    Constant Field Values
  - charSetEncoding
```
private java.lang.String charSetEncoding
```
  - xmlVersion
```
private java.lang.String xmlVersion
```
  - contentType
```
private java.lang.String contentType
```
  - contentTypeSet
```
private boolean contentTypeSet
```
    Flag set if contentType has been set explicitly through setContentType(String). If this attribute is false and contentType is non null, then it was calculated by getContentType().
  - ignoreXMLDeclaration
```
private boolean ignoreXMLDeclaration
```
  - autoCloseWriter
```
private boolean autoCloseWriter
```
  - ACTION_PROPERTY
```
public static final java.lang.String ACTION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - xmlStreamWriterFilter
```
private XMLStreamWriterFilter xmlStreamWriterFilter
```
  - writerConfiguration
```
private StAXWriterConfiguration writerConfiguration
```
  - multipartWriterFactory
```
private MultipartWriterFactory multipartWriterFactory
```
  - USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS
```
public static final java.lang.String USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS
```
    See Also:
    
    Constant Field Values
  - RESPECT_SWA_ATTACHMENT_ORDER
```
public static final java.lang.String RESPECT_SWA_ATTACHMENT_ORDER
```
    Deprecated. As of version 1.2.13, Axiom always respects the order of attachments.
    
    See Also:
    
    Constant Field Values
  - RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT
```
public static final java.lang.Boolean RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT
```
    Deprecated. As of version 1.2.13, Axiom always respects the order of attachments.
  - map
```
private java.util.HashMap map
```
- Constructor Detail
  - OMOutputFormat
```
public OMOutputFormat()
```
  - OMOutputFormat
```
public OMOutputFormat(OMOutputFormat format)
```
    Constructs a new instance by copying the configuration from an existing instance. Note that this will only copy configuration data, but not information that is subject to auto-generation, such as the root content ID or the MIME boundary.
    
    Parameters:
    
    format - the existing instance
- Method Detail
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
```
    Parameters:
    
    key - String
    
    Returns:
    
    property or null
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.Object value)
```
    Parameters:
    
    key - String
    
    value - Object
    
    Returns:
    
    old value or null
  - containsKey
```
public boolean containsKey(java.lang.String key)
```
    Parameters:
    
    key -
    
    Returns:
    
    true if known key
  - isOptimized
```
public boolean isOptimized()
```
    Indicates whether the document should be serialized using MTOM.
    
    Returns:
    
    true if the document should be serialized using MTOM; false otherwise; the return value is always false if isDoingSWA() returns true
  - getContentType
```
public java.lang.String getContentType()
```
    Return the content-type value that should be written with the message. (i.e. if optimized, then a multipart/related content-type is returned).
    
    Returns:
    
    content-type value
  - setContentType
```
public void setContentType(java.lang.String c)
```
    Set a raw content-type (i.e. "text/xml" (SOAP 1.1) or "application/xml" (REST)) If this method is not invoked, OMOutputFormat will choose a content-type value consistent with the soap version.
    
    Parameters:
    
    c -
  - getMimeBoundary
```
public java.lang.String getMimeBoundary()
```
  - getRootContentId
```
public java.lang.String getRootContentId()
```
  - getNextContentId
```
public java.lang.String getNextContentId()
```
  - getCharSetEncoding
```
public java.lang.String getCharSetEncoding()
```
    Returns the character set encoding scheme.
    
    Returns:
    
    Returns encoding string or null if it has not been set.
  - setCharSetEncoding
```
public void setCharSetEncoding(java.lang.String charSetEncoding)
```
  - getXmlVersion
```
public java.lang.String getXmlVersion()
```
  - setXmlVersion
```
public void setXmlVersion(java.lang.String xmlVersion)
```
  - setSOAP11
```
public void setSOAP11(boolean b)
```
  - isSOAP11
```
public boolean isSOAP11()
```
  - isIgnoreXMLDeclaration
```
public boolean isIgnoreXMLDeclaration()
```
  - setIgnoreXMLDeclaration
```
public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)
```
  - setDoOptimize
```
public void setDoOptimize(boolean optimize)
```
    Specifies that the document should be serialized using MTOM. Note that this setting is ignored if SwA is enabled using setDoingSWA(boolean).
    
    Parameters:
    
    optimize - true if the document should be serialized using MTOM; false otherwise
  - isDoingSWA
```
public boolean isDoingSWA()
```
    Indicates whether the document should be serialized using SwA.
    
    Returns:
    
    true if the document should be serialized using SwA; false otherwise
  - setDoingSWA
```
public void setDoingSWA(boolean doingSWA)
```
    Specifies that the document should be serialized using SwA (SOAP with Attachments). When SwA is enabled, then any configuration done using setDoOptimize(boolean) is ignored.
    
    Parameters:
    
    doingSWA - true if the document should be serialized using SwA; false otherwise
  - getContentTypeForMTOM
```
public java.lang.String getContentTypeForMTOM(java.lang.String SOAPContentType)
```
    Generates a Content-Type value for MTOM messages. This is a MIME Multipart/Related Content-Type value as defined by RFC 2387 and the XOP specification. The generated header will look like the following: Content-Type: multipart/related; boundary="[MIME BOUNDARY VALUE]"; type="application/xop+xml"; start="[MESSAGE CONTENT ID]"; start-info="[MESSAGE CONTENT TYPE]";
    
    Parameters:
    
    SOAPContentType -
    
    Returns:
    
    TODO
  - getContentTypeForSwA
```
public java.lang.String getContentTypeForSwA(java.lang.String SOAPContentType)
```
  - isAutoCloseWriter
```
public boolean isAutoCloseWriter()
```
    Deprecated.
  - setAutoCloseWriter
```
public void setAutoCloseWriter(boolean autoCloseWriter)
```
    Deprecated.
  - setMimeBoundary
```
public void setMimeBoundary(java.lang.String mimeBoundary)
```
  - setRootContentId
```
public void setRootContentId(java.lang.String rootContentId)
```
  - toString
```
public java.lang.String toString()
```
    Use toString for logging state of the OMOutputFormat
    
    Overrides:
    
    toString in class java.lang.Object
  - setOptimizedThreshold
```
public void setOptimizedThreshold(int optimizedThreshold)
```
  - getOptimizedThreshold
```
public int getOptimizedThreshold()
```
  - getXmlStreamWriterFilter
```
public XMLStreamWriterFilter getXmlStreamWriterFilter()
```
    Returns:
    
    the xmlStreamWriterFilter
  - setXmlStreamWriterFilter
```
public void setXmlStreamWriterFilter(XMLStreamWriterFilter xmlStreamWriterFilter)
```
    Parameters:
    
    xmlStreamWriterFilter - the xmlStreamWriterFilter to set
  - getStAXWriterConfiguration
```
public StAXWriterConfiguration getStAXWriterConfiguration()
```
    Get the currently configured StAX writer configuration.
    
    Returns:
    
    the current configuration; StAXWriterConfiguration.DEFAULT if none has been set explicitly
  - setStAXWriterConfiguration
```
public void setStAXWriterConfiguration(StAXWriterConfiguration writerConfiguration)
```
    Set the StAX writer configuration that will be used when requesting an XMLStreamWriter from StAXUtils.
    
    Parameters:
    
    writerConfiguration - the configuration
  - getMultipartWriterFactory
```
public MultipartWriterFactory getMultipartWriterFactory()
```
    Get the currently configured multipart writer factory.
    
    Returns:
    
    the current factory; if none has been set explicitly, an AxiomMultipartWriterFactory instance is returned
  - setMultipartWriterFactory
```
public void setMultipartWriterFactory(MultipartWriterFactory multipartWriterFactory)
```
    Set the multipart writer factory. This factory is used to create MIME packages when MTOM or SwA is enabled.
    
    Parameters:
    
    multipartWriterFactory - the factory

Class OMOutputFormat

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

mimeBoundary

rootContentId

nextid

doOptimize

doingSWA

isSoap11

optimizedThreshold

DEFAULT_CHAR_SET_ENCODING

charSetEncoding

xmlVersion

contentType

contentTypeSet

ignoreXMLDeclaration

autoCloseWriter

ACTION_PROPERTY

xmlStreamWriterFilter

writerConfiguration

multipartWriterFactory

USE_CTE_BASE64_FOR_NON_TEXTUAL_ATTACHMENTS

RESPECT_SWA_ATTACHMENT_ORDER

RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT

map

Constructor Detail

OMOutputFormat

OMOutputFormat

Method Detail

getProperty

setProperty

containsKey

isOptimized

getContentType

setContentType

getMimeBoundary

getRootContentId

getNextContentId

getCharSetEncoding

setCharSetEncoding

getXmlVersion

setXmlVersion

setSOAP11

isSOAP11

isIgnoreXMLDeclaration

setIgnoreXMLDeclaration

setDoOptimize

isDoingSWA

setDoingSWA

getContentTypeForMTOM

getContentTypeForSwA

isAutoCloseWriter

setAutoCloseWriter

setMimeBoundary

setRootContentId

toString

setOptimizedThreshold

getOptimizedThreshold

getXmlStreamWriterFilter

setXmlStreamWriterFilter

getStAXWriterConfiguration

setStAXWriterConfiguration

getMultipartWriterFactory

setMultipartWriterFactory