com.exalead.mercury.mami.master.v10

Class ApplyConfiguration

java.lang.Object

com.exalead.mercury.mami.master.v10.ApplyConfiguration

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ApplyConfiguration
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Application and rollback
Apply a given configuration.
For each store entry, the latest available version will be
used unless it is overriden by an entry in StoreEntryList.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	applyPostRestarts
java.lang.String	author
java.lang.String	comment
static boolean	DEFAULT_APPLY_POST_RESTARTS
static boolean	DEFAULT_FORCE_IF_DOWN
static boolean	DEFAULT_IGNORE_PREVIOUS_VERSION
static boolean	DEFAULT_TEST
static boolean	DEFAULT_WRITE_ONLY
boolean	forceIfDown
boolean	ignorePreviousVersion
StoreEntryList	storeEntryList
boolean	test
boolean	writeOnly

Constructor Summary

Constructors

Constructor and Description
ApplyConfiguration()
ApplyConfiguration(ApplyConfiguration o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ApplyConfiguration.
static ApplyConfiguration	fromString(java.lang.String s) String representation of this ApplyConfiguration.
java.lang.String	getAuthor() User applying the configuration.
java.lang.String	getComment() Use this field to describe the changes of this new version.
StoreEntryList	getStoreEntryList()
boolean	isApplyPostRestarts() Should the process restarts flagged as being executable independently be processed right now? Note that using this can lead to search service down time.
boolean	isForceIfDown() Should the configuration be applied even if some hosts are down? This option should be used with extreme care.
boolean	isIgnorePreviousVersion() Ignores the previous version of the configuration. This means that the configuration application will not take into account all configuration changes. You will need to restart relevant processes manually.
boolean	isTest() Should the configuration be only tested.
boolean	isWriteOnly() EXPERT ONLY Should the configuration be written to disk only. This parameter is used by the installer process.
ApplyConfiguration	makeCopy() Creates and returns a deep copy of this ApplyConfiguration.
static ApplyConfiguration	readFrom(java.io.InputStream is) Read this ApplyConfiguration from an XML fragment.
void	setApplyPostRestarts(boolean applyPostRestarts) Should the process restarts flagged as being executable independently be processed right now? Note that using this can lead to search service down time.
void	setAuthor(java.lang.String author) User applying the configuration.
void	setComment(java.lang.String comment) Use this field to describe the changes of this new version.
void	setForceIfDown(boolean forceIfDown) Should the configuration be applied even if some hosts are down? This option should be used with extreme care.
void	setIgnorePreviousVersion(boolean ignorePreviousVersion) Ignores the previous version of the configuration. This means that the configuration application will not take into account all configuration changes. You will need to restart relevant processes manually.
void	setStoreEntryList(StoreEntryList storeEntryList)
void	setTest(boolean test) Should the configuration be only tested.
void	setWriteOnly(boolean writeOnly) EXPERT ONLY Should the configuration be written to disk only. This parameter is used by the installer process.
java.lang.String	toString() String representation of this ApplyConfiguration.
ApplyConfiguration	withApplyPostRestarts(boolean applyPostRestarts)
ApplyConfiguration	withApplyPostRestarts(java.lang.Boolean applyPostRestarts)
ApplyConfiguration	withAuthor(java.lang.String author)
ApplyConfiguration	withComment(java.lang.String comment)
ApplyConfiguration	withForceIfDown(boolean forceIfDown)
ApplyConfiguration	withForceIfDown(java.lang.Boolean forceIfDown)
ApplyConfiguration	withIgnorePreviousVersion(boolean ignorePreviousVersion)
ApplyConfiguration	withIgnorePreviousVersion(java.lang.Boolean ignorePreviousVersion)
ApplyConfiguration	withStoreEntryList(StoreEntryList storeEntryList)
ApplyConfiguration	withTest(boolean test)
ApplyConfiguration	withTest(java.lang.Boolean test)
ApplyConfiguration	withWriteOnly(boolean writeOnly)
ApplyConfiguration	withWriteOnly(java.lang.Boolean writeOnly)
void	writeTo(java.io.OutputStream os) Write this ApplyConfiguration as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

storeEntryList

public StoreEntryList storeEntryList

test

public boolean test

DEFAULT_TEST

public static final boolean DEFAULT_TEST

See Also:

Constant Field Values

writeOnly

public boolean writeOnly

DEFAULT_WRITE_ONLY

public static final boolean DEFAULT_WRITE_ONLY

See Also:

Constant Field Values

applyPostRestarts

public boolean applyPostRestarts

DEFAULT_APPLY_POST_RESTARTS

public static final boolean DEFAULT_APPLY_POST_RESTARTS

See Also:

Constant Field Values

forceIfDown

public boolean forceIfDown

DEFAULT_FORCE_IF_DOWN

public static final boolean DEFAULT_FORCE_IF_DOWN

See Also:

Constant Field Values

ignorePreviousVersion

public boolean ignorePreviousVersion

DEFAULT_IGNORE_PREVIOUS_VERSION

public static final boolean DEFAULT_IGNORE_PREVIOUS_VERSION

See Also:

Constant Field Values

comment

public java.lang.String comment

author

public java.lang.String author

Constructor Detail

ApplyConfiguration

public ApplyConfiguration()

ApplyConfiguration

public ApplyConfiguration(ApplyConfiguration o)

Copy constructor

Method Detail

setStoreEntryList

public void setStoreEntryList(StoreEntryList storeEntryList)

getStoreEntryList

public StoreEntryList getStoreEntryList()

withStoreEntryList

public ApplyConfiguration withStoreEntryList(StoreEntryList storeEntryList)

setTest

public void setTest(boolean test)

Should the configuration be only tested.

isTest

public boolean isTest()

Should the configuration be only tested.

withTest

public ApplyConfiguration withTest(boolean test)

withTest

public ApplyConfiguration withTest(java.lang.Boolean test)

setWriteOnly

public void setWriteOnly(boolean writeOnly)

EXPERT ONLY Should the configuration be written to disk only.
This parameter is used by the installer process.

isWriteOnly

public boolean isWriteOnly()

EXPERT ONLY Should the configuration be written to disk only.
This parameter is used by the installer process.

withWriteOnly

public ApplyConfiguration withWriteOnly(boolean writeOnly)

withWriteOnly

public ApplyConfiguration withWriteOnly(java.lang.Boolean writeOnly)

setApplyPostRestarts

public void setApplyPostRestarts(boolean applyPostRestarts)

Should the process restarts flagged as being executable independently be processed right now?
Note that using this can lead to search service down time.

isApplyPostRestarts

public boolean isApplyPostRestarts()

Should the process restarts flagged as being executable independently be processed right now?
Note that using this can lead to search service down time.

withApplyPostRestarts

public ApplyConfiguration withApplyPostRestarts(boolean applyPostRestarts)

withApplyPostRestarts

public ApplyConfiguration withApplyPostRestarts(java.lang.Boolean applyPostRestarts)

setForceIfDown

public void setForceIfDown(boolean forceIfDown)

Should the configuration be applied even if some hosts are down?
This option should be used with extreme care.

isForceIfDown

public boolean isForceIfDown()

Should the configuration be applied even if some hosts are down?
This option should be used with extreme care.

withForceIfDown

public ApplyConfiguration withForceIfDown(boolean forceIfDown)

withForceIfDown

public ApplyConfiguration withForceIfDown(java.lang.Boolean forceIfDown)

setIgnorePreviousVersion

public void setIgnorePreviousVersion(boolean ignorePreviousVersion)

Ignores the previous version of the configuration.
This means that the configuration application will not take into account all configuration changes.
You will need to restart relevant processes manually.

isIgnorePreviousVersion

public boolean isIgnorePreviousVersion()

Ignores the previous version of the configuration.
This means that the configuration application will not take into account all configuration changes.
You will need to restart relevant processes manually.

withIgnorePreviousVersion

public ApplyConfiguration withIgnorePreviousVersion(boolean ignorePreviousVersion)

withIgnorePreviousVersion

public ApplyConfiguration withIgnorePreviousVersion(java.lang.Boolean ignorePreviousVersion)

setComment

public void setComment(java.lang.String comment)

Use this field to describe the changes of this new version.

getComment

public java.lang.String getComment()

Use this field to describe the changes of this new version.

withComment

public ApplyConfiguration withComment(java.lang.String comment)

setAuthor

public void setAuthor(java.lang.String author)

User applying the configuration.

getAuthor

public java.lang.String getAuthor()

User applying the configuration.

withAuthor

public ApplyConfiguration withAuthor(java.lang.String author)

makeCopy

public ApplyConfiguration makeCopy()

Creates and returns a deep copy of this ApplyConfiguration.

readFrom

public static ApplyConfiguration readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException

Read this ApplyConfiguration from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ApplyConfiguration as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ApplyConfiguration fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException

String representation of this ApplyConfiguration.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ApplyConfiguration.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ApplyConfiguration.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException