oracle.axia.api.management.cm

Interface ConfigurationAdminMBean

public interface ConfigurationAdminMBean

MBean exposed by the configuration service.

Author:

Copyright (c) 2010 by Oracle Corp. All Rights Reserved.

Method Summary

Modifier and Type	Method and Description
void	begin() Start transaction update.
void	commit() Commits any changes made since the transaction update was started using the begin operation.
void	copyConfiguration(java.lang.String symbolicName, java.lang.String fromVersion, java.lang.String toVersion) Copy configuration between bundle versions.
java.lang.String	getConfiguration(java.lang.String symbolicName, java.lang.String bundleVersion, java.lang.String filename, java.lang.String configVersion) Get configuration XML document.
boolean	isTransactionActive() Indicates if transaction update is active.
java.lang.String[]	listConfigurationVersions(java.lang.String symbolicName, java.lang.String bundleVersion, java.lang.String filename) List all versions where a specific configuration has changed.
java.util.List<java.lang.String>	listPendingConfiguration() List pending configuration entries since the transaction update started.
void	rollback() Rollback any active changes since transaction update was started.

Method Detail

begin

void begin()

Start transaction update. Configuration changes after invoking this operation will not be committed until commit is invoked. Changes can also be reverted using the rollback operation.

Throws:

java.lang.IllegalStateException - If transaction update is already active.

commit

void commit()

Commits any changes made since the transaction update was started using the begin operation.

Throws:

java.lang.IllegalStateException - If transaction update is not active.

java.lang.IllegalArgumentException - On validation errors.

java.lang.RuntimeException - On commit errors.

rollback

void rollback()

Rollback any active changes since transaction update was started.

Throws:

java.lang.IllegalStateException - If transaction update is not active.

isTransactionActive

boolean isTransactionActive()

Indicates if transaction update is active.

Returns:

Boolean indicating if transaction update is active.

listPendingConfiguration

java.util.List<java.lang.String> listPendingConfiguration()

List pending configuration entries since the transaction update started.

Returns:

List of configuration entries.

Throws:

java.lang.IllegalStateException - If transaction update is not active.

copyConfiguration

void copyConfiguration(java.lang.String symbolicName,
                       java.lang.String fromVersion,
                       java.lang.String toVersion)

Copy configuration between bundle versions.

Parameters:

symbolicName - The symbolic name of the bundle

fromVersion - The version of the source bundle

toVersion - The version of the target bundle

Throws:

java.lang.IllegalArgumentException - For invalid input.

listConfigurationVersions

java.lang.String[] listConfigurationVersions(java.lang.String symbolicName,
                                             java.lang.String bundleVersion,
                                             java.lang.String filename)

List all versions where a specific configuration has changed.

Parameters:

symbolicName - Bundle symbolic name

bundleVersion - Bundle version

filename - Configuration file name

Returns:

List of all configuration version. Listed in reversed chronological order, starting with current version.

getConfiguration

java.lang.String getConfiguration(java.lang.String symbolicName,
                                  java.lang.String bundleVersion,
                                  java.lang.String filename,
                                  java.lang.String configVersion)

Get configuration XML document.

Parameters:

symbolicName - Bundle symbolic name

bundleVersion - Bundle version

filename - Configuration file name

configVersion - Configuration version

Returns:

XML document