Integration Toolbox
for IBM® TIVOLI® Storage Manager

package query; import static hu.user.toolbox.tsm.ITSMSession.MAXDATE; import static hu.user.toolbox.tsm.ITSMSession.MINDATE; import hu.user.toolbox.tsm.IArchiveObject; import hu.user.toolbox.tsm.IFilespace; import hu.user.toolbox.tsm.IResultSet; import hu.user.toolbox.tsm.ITSMSession; 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.IArchiveQuery; /** * <b>Function:</b><br> * Queries archive objects. Prints the detailed information of every object. * <p> * Before executing this program send some objects to the server using * the ArchiveSingleObject, ArchiveSingleObjectManagementClassOverride or * ArchiveMultipleObjects 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 with the name from command line arguments.</li> * <li>Querying archive objects with the following parameters: * high-level name "/ARCHIVE", low-level name "/*" and object type "ANY_TYPE".</li> * <li>Iterating through the returned ResultSet, printing the details of * each match, then closing the result set.</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 query/ * </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 query.QueryArchiveObjects {filespace-name} * </pre> */ public class QueryArchiveObjects { private static final String NODE_NAME = "TOOLBOX"; private static final String PASSWORD = "PASSWORD"; private static final String LOW_LEVEL_NAME_ANY = "/*"; private static final String HIGH_LEVEL_NAME = "/ARCHIVE"; public static void main(final String args[]) throws ToolboxException { ITSMSession session = null; String filespaceName = null; if(args.length<1){ System.out.println("Usage: java QueryArchiveObjects {filespace name}."); return; }else{ filespaceName = args[0]; } 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(filespaceName); if (filespace == null) { System.out.printf("Warning: %s does not exist.\n", filespaceName); return; } IResultSet archiveObjects = null; IArchiveQuery archiveQuery = filespace.createArchiveQuery(); boolean hasObjects = false; try { // Querying all archive objects of the filespace matching the specified criteria archiveObjects = archiveQuery .highLevelNameMatches(HIGH_LEVEL_NAME) .lowLevelNameMatches(LOW_LEVEL_NAME_ANY) .ownerMatchesAny() // Matches any owner name .descriptionMatchesAny() // Matches any description .insertedBetween(MINDATE, MAXDATE) // Matches any insert date .expireBetween(MINDATE, MAXDATE) // Matches any expiration date .filesAndDirectories() // Query for both files and directories .execute(); // Execute the query // Iterating over the returned result set while ( { hasObjects = true; IArchiveObject archiveObject = (IArchiveObject) archiveObjects.get(); printDetails(archiveObject); } if (!hasObjects) { System.out.printf("The filespace '%s' does not contain any archive objects.\n", filespaceName); } } catch (Exception e) { e.printStackTrace(); } finally { // The result set must be closed. archiveObjects.close(); } } catch (ToolboxException e) { e.printStackTrace(); } finally { // Disconnecting session.disconnect(); // Cleaning up the environment Toolbox.cleanUp(); } } /** * Prints the details of an archive object. */ private static void printDetails(IArchiveObject 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(" Description: %s\n", o.getDescription()); 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(" Retention initated: %s\n", o.getRetentionInitiated()); System.out.printf(" Object held?: %s\n", o.getHeld()); 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(); } }