Integration Toolbox
for IBM® TIVOLI® Storage Manager

package backup_restore; import hu.user.toolbox.tsm.IBackupObject; import hu.user.toolbox.tsm.IFilespace; import hu.user.toolbox.tsm.IResultSet; import hu.user.toolbox.tsm.ITSMSession; import hu.user.toolbox.tsm.ManagementClass; import hu.user.toolbox.tsm.Toolbox; import hu.user.toolbox.tsm.exception.ToolboxException; import hu.user.toolbox.tsm.internal.structures.DsUint160_t; import hu.user.toolbox.tsm.query.IBackupQuery; /** * <b>Function:</b><br> * Updating an existing backup object sent using the BackupSingleObject.java example. * <p> * Before executing this program send an object to the server using * the BackupSingleObject sample. * <p> * The following operations are performed: * <ol> * <li>Initializing a single-threaded TSM API environment.</li> * <li>Creating a new TSMSession instance. * Setting default connection options. Connecting to the server using * the node name "TOOLBOX" and password "PASSWORD".</li> * <li>Retrieving the filespace named "/BACKUPFS".</li> * <li>Querying backup objects with the parameters: * high-level name "/BACKUP", low-level name "/OBJECT1 and object type "FILE".</li> * <li>Updating all fields.</li> * <li>Disconnecting from the server and cleaning up the resources.</li> * </ol> * <p> * <b>Compile:</b> * <pre> * javac -d bin -cp ../lib/toolboxfortsm.jar backup_restore/UpdateBackupObject.java * </pre> * <p> * <b>Execute:</b><br> * You should first set the environment variables to point to the correct * files/directories. * <pre> * set DSMI_CONFIG={Full path of your dsm.opt} * set DSMI_DIR={Tivoli Storage Manager API installation directory} * set DSMI_LOG={Any arbitrary directory} * </pre> * Then use the java command to execute the program: * <p> * <pre> * java -cp bin:../lib/toolboxfortsm.jar:../lib/ext/log4j-1.2.17.jar:../config * -Djava.library.path=../lib backup_restore.UpdateBackupObject * </pre> */ public class UpdateBackupObject { private static final String NODE_NAME = "TOOLBOX"; private static final String PASSWORD = "PASSWORD"; private static final String LOW_LEVEL_NAME = "/OBJECT1"; private static final String HIGH_LEVEL_NAME = "/BACKUP"; private static final String FILESPACE_NAME = "/BACKUPFS"; private static final String INFORMATION_UPDATED = "information_updated"; private static final String OWNER_UPDATED = "Owner_updated"; private static final String MANAGEMENT_CLASS_NAME = "TOOLBOX_MGMT_BCG"; public static void main(final String args[]) throws ToolboxException { ITSMSession session = null; try { // Initializing a single-threaded environment Toolbox.initSingleThreading(); // Connecting to the server with the default connection options session = Toolbox.createSession(NODE_NAME, PASSWORD); // Retrieving the existing filespace from server IFilespace filespace = session.retrieveFilespace(FILESPACE_NAME); // Checking if filespace exists if (filespace == null) { System.out.printf("Warning: '%s' does not exists.\n", FILESPACE_NAME); return; } IBackupObject backupObject = null; IBackupQuery backupQuery = filespace.createBackupQuery(); IResultSet backups = null; try{ // Querying all backup objects matching the specified criteria backups = backupQuery .highLevelNameMatches(HIGH_LEVEL_NAME) .lowLevelNameMatches(LOW_LEVEL_NAME) .ownerMatchesAny() // Matches any owner name .files() // Query for files .allVersions() // Query for both active and inactive versions .execute(); // Execute the query // Iterating over the returned result set while (backups.next()) { backupObject = (IBackupObject) backups.get(); break; } } catch (Exception e) { e.printStackTrace(); } finally{ // The result set must be closed. backups.close(); } // Check if object has been backup up. if (backupObject == null) { System.out.printf("The object '%s%s%s' doesn't exist on the server.\n", FILESPACE_NAME, HIGH_LEVEL_NAME, LOW_LEVEL_NAME); return; } System.out.println("The original fields of the backup object:\n"); printDetails(backupObject); ManagementClass managementClassUpdated = session.getManagementClass(MANAGEMENT_CLASS_NAME); // Setting new values and updating fields backupObject.setManagementClass(managementClassUpdated); backupObject.setInformation(INFORMATION_UPDATED); backupObject.setOwner(OWNER_UPDATED); backupObject.setEstimatedSize(backupObject.getEstimatedSize() + 1); // Updating the fields backupObject.update(); backupQuery = filespace.createBackupQuery(); try{ // Querying all backup objects matching the specified criteria backups = backupQuery .highLevelNameMatches(HIGH_LEVEL_NAME) .lowLevelNameMatches(LOW_LEVEL_NAME) .ownerMatchesAny() // Matches any owner name .files() // Query for files .allVersions() // Query for both active and inactive versions .execute(); // Execute the query // Iterating over the returned result set while (backups.next()) { backupObject = (IBackupObject) backups.get(); break; } } catch (Exception e) { e.printStackTrace(); } finally{ // The result set must be closed. backups.close(); } System.out.println("The updated fields of the backup object:\n"); printDetails(backupObject); } catch (ToolboxException e) { e.printStackTrace(); } finally { // Disconnecting session.disconnect(); // Cleaning up the environment Toolbox.cleanUp(); } } /** * Prints the details of the backup object. * * @param o the {@code IBackupObject} object */ private static void printDetails(IBackupObject o){ DsUint160_t restOrder = o.getRestoreOrderExt(); System.out.printf(" Name: %s%s%s\n", o.getFilespaceName(), o.getHighLevelName(), o.getLowLevelName()); System.out.printf(" Object type: %s\n", o.getType()); System.out.printf(" Object state: %s\n", o.getState()); System.out.printf(" Insert date: %s\n", o.getInsertionDate()); System.out.printf(" Expiration date: %s\n", o.getExpirationDate()); System.out.printf(" Owner: %s\n", o.getOwner()); System.out.printf(" Restore order: %d-%d-%d-%d-%d\n", restOrder.getTop(), restOrder.getHi_hi(), restOrder.getHi_lo(), restOrder.getLo_hi(), restOrder.getLo_lo()); System.out.printf(" Object ID: %d\n", o.getId()); System.out.printf(" Copy group: %d\n", o.getCopyGroup()); System.out.printf(" Media class: %s\n", o.getMediaClass()); System.out.printf(" Management class: %s\n", o.getManagementClass().getName()); System.out.printf(" Object information: %s\n", o.getInformation()); System.out.printf("Estimated size (byte): %d\n", o.getEstimatedSize()); System.out.printf(" Compression: %s\n", o.getCompressionType()); System.out.printf(" Encryption: %s\n", o.getEncryptionType()); System.out.printf(" Client deduplicated: %s\n", o.isClientDeduplicated() ? "YES" : "NO"); System.out.println(); } }