Package org.apache.juneau.soap

Class SoapXmlSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.xml.XmlSerializer

org.apache.juneau.soap.SoapXmlSerializer

All Implemented Interfaces:

AnnotationProvider, SoapXmlMetaProvider, XmlMetaProvider

public class SoapXmlSerializer
extends XmlSerializer
implements SoapXmlMetaProvider

Serializes POJOs to HTTP responses as XML+SOAP.

Media types

Handles Accept types: text/xml+soap

Produces Content-Type types: text/xml+soap

Description

Essentially the same output as XmlDocSerializer, except wrapped in a standard SOAP envelope.

Notes:

• This class is thread safe and reusable.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoapXmlSerializer.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer

XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable, XmlSerializer.Sq, XmlSerializer.SqReadable

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.xml.XmlSerializer

DEFAULT, DEFAULT_JUNEAU_NAMESPACE, DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, DEFAULT_SQ, DEFAULT_SQ_READABLE, DEFAULT_XS_NAMESPACE

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DEFAULT, DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
SoapXmlSerializer(SoapXmlSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
SoapXmlSerializer.Builder	copy()	Creates a builder from this context object.
static SoapXmlSerializer.Builder	create()	Creates a new builder for this object.
SoapXmlSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
SoapXmlSerializerSession	getSession()	Returns a session to use for this context.
String	getSoapAction()	The SOAPAction HTTP header value to set on responses.
SoapXmlBeanPropertyMeta	getSoapXmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
SoapXmlClassMeta	getSoapXmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.xml.XmlSerializer

getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isAddBeanTypes, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, serialize, toString

Methods inherited from class org.apache.juneau.serializer.Serializer

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Constructor Details

SoapXmlSerializer

public SoapXmlSerializer(SoapXmlSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static SoapXmlSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public SoapXmlSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class XmlSerializer

Returns:

A new Builder object.

createSession

public SoapXmlSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class XmlSerializer

Returns:

A new session builder.

getSession

public SoapXmlSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class XmlSerializer

Returns:

A new session object.

getSoapXmlClassMeta

public SoapXmlClassMeta getSoapXmlClassMeta(ClassMeta<?> cm)

Description copied from interface: SoapXmlMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getSoapXmlClassMeta in interface SoapXmlMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSoapXmlBeanPropertyMeta

public SoapXmlBeanPropertyMeta getSoapXmlBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: SoapXmlMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getSoapXmlBeanPropertyMeta in interface SoapXmlMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getSoapAction

public String getSoapAction()

The SOAPAction HTTP header value to set on responses.

Returns:

The SOAPAction HTTP header value to set on responses.

See Also:

• SoapXmlSerializer.Builder.soapAction(String)

properties

protected JsonMap properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class XmlSerializer

Returns:

The properties on this bean as a map for debugging.