Module com.oracle.bedrock.runtime.windows

Package com.oracle.bedrock.runtime.remote.windows.winrm

Class WindowsSoapOptions

java.lang.Object

com.oracle.bedrock.runtime.remote.windows.winrm.WindowsSoapOptions

All Implemented Interfaces:

com.oracle.bedrock.ComposableOption<WindowsSoapOptions>, com.oracle.bedrock.Option

public class WindowsSoapOptions
extends Object
implements com.oracle.bedrock.Option, com.oracle.bedrock.ComposableOption<WindowsSoapOptions>

An Option that controls various settings in the SOAP envelope header for a WinRM SOAP message.

Copyright (c) 2015. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowsSoapOptions.Type	Enum description

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Field Summary

Fields

Modifier and Type	Field	Description
static final BigInteger	DEFAULT_MAX_ENVELOPE_SIZE	The default maximum envelope size for SOAP messages.
static final Duration	DEFAULT_TIMEOUT	The default timeout value for SOAP messages.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WindowsSoapOptions(Map<WindowsSoapOptions.Type,Object> options)

Method Summary

Modifier and Type	Method	Description
static WindowsSoapOptions	basic()	Factory method to create the minimum required set of WindowsSoapOptions.
WindowsSoapOptions	compose(WindowsSoapOptions other)
BigInteger	getMaxEnvelopeSize()	Obtain the maximum envelope size to use for SOAP messages.
Map<WindowsSoapOptions.Type,Object>	getOptions()	Obtain an unmodifiable Map of the options contained within this WindowsSoapOptions.
Duration	getTimeout()	Obtain the timeout value to use for SOAP messages.
WindowsSoapOptions	withMaxEnvelopeSize(BigInteger size)	Set the maximum SOAP envelope size.
WindowsSoapOptions	withTimeout(long timeout, TimeUnit units)	Set the message timeout value.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_ENVELOPE_SIZE

public static final BigInteger DEFAULT_MAX_ENVELOPE_SIZE

The default maximum envelope size for SOAP messages.

DEFAULT_TIMEOUT

public static final Duration DEFAULT_TIMEOUT

The default timeout value for SOAP messages.

Constructor Details

WindowsSoapOptions

protected WindowsSoapOptions(Map<WindowsSoapOptions.Type,Object> options)

Method Details

basic

public static WindowsSoapOptions basic()

Factory method to create the minimum required set of WindowsSoapOptions.

Returns:

a WindowsSoapOptions containing the minimum set of required options.

getOptions

public Map<WindowsSoapOptions.Type,Object> getOptions()

Obtain an unmodifiable Map of the options contained within this WindowsSoapOptions.

Returns:

an unmodifiable Map of the options contained within this WindowsSoapOptions

withMaxEnvelopeSize

public WindowsSoapOptions withMaxEnvelopeSize(BigInteger size)

Set the maximum SOAP envelope size.

Parameters:

size - the maximum SOAP envelope size

Returns:

this WindowsSoapOptions

getMaxEnvelopeSize

public BigInteger getMaxEnvelopeSize()

Obtain the maximum envelope size to use for SOAP messages.

Returns:

the maximum envelope size to use for SOAP messages

withTimeout

public WindowsSoapOptions withTimeout(long timeout,
 TimeUnit units)

Set the message timeout value.

Parameters:

timeout - the timeout duration

units - the units to apply to the timeout duration

Returns:

this WindowsSoapOptions

getTimeout

public Duration getTimeout()

Obtain the timeout value to use for SOAP messages.

Returns:

the timeout value to use for SOAP messages

compose

public WindowsSoapOptions compose(WindowsSoapOptions other)

Specified by:

compose in interface com.oracle.bedrock.ComposableOption<WindowsSoapOptions>