oracle.adf.share.sandbox.update

Class SandboxUpdatePatchInfo

java.lang.Object

oracle.adf.share.sandbox.update.SandboxUpdatePatchInfo

public final class SandboxUpdatePatchInfo
extends java.lang.Object

Information about a patch that initiates sandbox updates.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_IMMEDIATE Property (with value "true") to indicate that affected sandboxes must be updated immediately before they can be used again; otherwise the update may be deferred until next sandbox refresh.

Constructor Summary

Constructors

Constructor and Description
SandboxUpdatePatchInfo(java.lang.String patchId) Constructs a SandboxUpdatePatchInfo with only the ID of the patch.
SandboxUpdatePatchInfo(java.lang.String patchId, boolean isImmediate) Constructs a SandboxUpdatePatchInfo and indicates whether the sandboxes affected by this patch must be updated immediately before they can be used again.
SandboxUpdatePatchInfo(java.lang.String patchId, java.util.Map<java.lang.String,java.lang.String> properties) Constructs a SandboxUpdatePatchInfo with the ID of the patch and some properties.

Method Summary

Modifier and Type	Method and Description
static SandboxUpdatePatchInfo	fromXml(java.lang.String xml) Parses the XML representation of an PatchInfo object and returns the object.
java.lang.String	getCanonicalPatchId() Returns the patch ID in canonical form.
java.lang.String	getPatchId() Returns the ID of the patch, which is never null.
java.lang.String	getProperty(java.lang.String name) Returns the value of a property.
boolean	isImmediate() Returns true if this patch must be applied to affected sandboxes immediately before they can be used again.
static boolean	isImmediate(java.lang.String canonicalPatchId) Returns true if the given canonical patch ID indicates that the patch must be applied immediately.
java.util.Set<java.lang.String>	propertyNameSet() Returns the names of all properties.
java.lang.String	toString()
java.lang.String	toXml() Returns the XML representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

IS_IMMEDIATE

public static final java.lang.String IS_IMMEDIATE

Property (with value "true") to indicate that affected sandboxes must be updated immediately before they can be used again; otherwise the update may be deferred until next sandbox refresh.

See Also:

Constant Field Values

Constructor Detail

SandboxUpdatePatchInfo

public SandboxUpdatePatchInfo(java.lang.String patchId)

Constructs a SandboxUpdatePatchInfo with only the ID of the patch.

Parameters:

patchId - the ID of the patch

Throws:

java.lang.IllegalArgumentException - if the ID of the patch is null

SandboxUpdatePatchInfo

public SandboxUpdatePatchInfo(java.lang.String patchId,
                              boolean isImmediate)

Constructs a SandboxUpdatePatchInfo and indicates whether the sandboxes affected by this patch must be updated immediately before they can be used again.

Parameters:

patchId - the ID of the patch

isImmediate - if true, the constructed object will have one and only one property that is IS_IMMEDIATE with value "true"

Throws:

java.lang.IllegalArgumentException - if the ID of the patch is null

SandboxUpdatePatchInfo

public SandboxUpdatePatchInfo(java.lang.String patchId,
                              java.util.Map<java.lang.String,java.lang.String> properties)

Constructs a SandboxUpdatePatchInfo with the ID of the patch and some properties.

Parameters:

patchId - the ID of the patch

properties - properties of the patch; null if the patch does not have any properties

Throws:

java.lang.IllegalArgumentException - if the ID of the patch is null or if the ID is longer than the maximum length allowed, which is usually 400 bytes

Method Detail

getPatchId

public java.lang.String getPatchId()

Returns the ID of the patch, which is never null.

Returns:

the ID of the patch

isImmediate

public boolean isImmediate()

Returns true if this patch must be applied to affected sandboxes immediately before they can be used again.

Returns:

true if this patch must be applied to affected sandboxes immediately before they can be used again

getCanonicalPatchId

public java.lang.String getCanonicalPatchId()

Returns the patch ID in canonical form.

Returns:

the patch ID in canonical form

isImmediate

public static boolean isImmediate(java.lang.String canonicalPatchId)

Returns true if the given canonical patch ID indicates that the patch must be applied immediately.

Parameters:

canonicalPatchId - the canonical patch ID to be checked

Returns:

true if the given canonical patch ID indicates that the patch must be applied immediately; false otherwise or if the given ID is null

getProperty

public java.lang.String getProperty(java.lang.String name)

Returns the value of a property.

Parameters:

name - the name of the property

Returns:

the value of the property; null if the property does not exist

propertyNameSet

public java.util.Set<java.lang.String> propertyNameSet()

Returns the names of all properties.

Returns:

the names of all properties; an empty set if this patch does not contain any properties

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXml

public java.lang.String toXml()

Returns the XML representation of this object.

Returns:

the XML representation of this object

See Also:

fromXml(java.lang.String)

fromXml

public static SandboxUpdatePatchInfo fromXml(java.lang.String xml)

Parses the XML representation of an PatchInfo object and returns the object.

Parameters:

xml - the XML representation of the object to be returned

Returns:

the object represented by the XML

See Also:

toXml()