com.metamatrix.admin.objects
Class MMScriptsContainer

java.lang.Object
  com.metamatrix.admin.objects.MMScriptsContainer

All Implemented Interfaces:

ScriptsContainer, java.io.Serializable

public class MMScriptsContainer
extends java.lang.Object
implements ScriptsContainer

Since:

4.3

See Also:

Serialized Form

Constructor Summary

MMScriptsContainer()

Method Summary

void	addFile(java.lang.String fileName, byte[] fileContents) Add file contents by name.
java.util.Collection	getFileNames() Get the file names of all scripts in this container.
void	saveAllToDirectory(java.lang.String directoryLocation, AdminOptions options) Save all of the scripts contained to the specified local directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

MMScriptsContainer

public MMScriptsContainer()

Since:

4.3

Method Detail

getFileNames

public java.util.Collection getFileNames()

Description copied from interface: ScriptsContainer

Get the file names of all scripts in this container.

Specified by:

getFileNames in interface ScriptsContainer

Returns:

The Collection of String file names of all scripts in this container. This collection may be empty if an error has occured.

Since:

4.3

See Also:

ScriptsContainer.getFileNames()

saveAllToDirectory

public void saveAllToDirectory(java.lang.String directoryLocation,
                               AdminOptions options)
                        throws AdminException

Description copied from interface: ScriptsContainer

Save all of the scripts contained to the specified local directory.

Specified by:

saveAllToDirectory in interface ScriptsContainer

Parameters:

directoryLocation - the directory location to save the contained scripts. Must be accessable from where this code is running.

options - Specify whether to AdminOptions.OnConflict.OVERWRITE or AdminOptions.OnConflict.EXCEPTION (default) when script files exist in the directoryLocation.

Throws:

AdminException - if there's an error saving the files.

Since:

4.3

See Also:

ScriptsContainer.saveAllToDirectory(java.lang.String, AdminOptions)

addFile

public void addFile(java.lang.String fileName,
                    byte[] fileContents)
             throws AdminComponentException

Add file contents by name.

Parameters:

fileName - - required

fileContents - - required

Throws:

AdminComponentException - if one of the required args are null or empty.