This chapter provides information about the Java and C example applications that are provided with the 5800 system SDK.
The following topics are discussed:
Table 2–1 summarizes the Java and C example applications provided with the 5800 system SDK. All code examples are command-line applications.
For detailed information about the Java example applications, see Java Example Applications.
For detailed information about the C example applications, see C Example Applications.
Table 2–1 5800 system Client SDK Example Applications
This section provides detailed information about the Java example applications provided with the 5800 system client SDK.
Included with the 5800 system SDK are several command-line example applications that demonstrate the Java API. The example applications are located in the SDK in the java/examples directory. These example applications come complete with a build script.
Make sure you configure your software environment before using the Java example applications.
Add C:\Program Files\Java\jdk_version\bin to the PATH environment variable where jdk_version is the version, for example, jdk5.0.
To edit the windows PATH environment variable:
Click the Start button.
Right-click My Computer and select properties to launch System Properties.
Click the Advanced tab.
Click Environment Variables.
Under System Variables, scroll down and click Path.
Click Edit to launch Edit System Variable.
Add the Java path name to the PATH environment variable. Make certain each path name is separated by a semicolon (;).
Click OK to close each window.
Also see Software Requirements.
UNIX (.sh) and Windows (.bat) scripts for running the example applications are provided in the java/scripts/ directory. These scripts must be run from the java/scripts/ directory. The scripts illustrate the CLASSPATH environment variable required. The .jar files are in the java/lib/ directory.
The usage messages printed by the applications omit the CLASSPATH environment variable for the sake of readability. If you are running the example application without using the provided scripts, then you must set the CLASSPATH environment variable manually.
To build the Java example applications, go to the java/examples/ directory and execute the master-build.sh script for Solaris and Linux environments or the master-build.bat script for Windows environments. These scripts build the examples and put them in the honeycomb-sdk.jar archive located in the java/lib directory.
Once you have built the Java example applications, go to the java/scripts directory and execute the .sh scripts for Solaris and Linux environments or .bat scripts for Windows environments:
Syntax: script_name arguments
See the scripts for details of how the applications are run.
The Java example applications are all simple applications that follow the same basic structure. First, Commandline.parse is called to parse the argument list. Next, the appropriate method in the NameValueObjectArchive class is called to communicate with the 5800 system server. Finally, output is delivered back to either standard output, a file, or both. Refer to the comments in the sample code for further details.
The following sections describe the Java example applications that are included with the 5800 system client SDK:
Stores a file and associated metadata to a 5800 system server.
java StoreFile <IP | HOST> <FILE> [OPTIONS]
Stores a file and its associated metadata record. If no -m options are specified, a metadata record without user content is generated. The OID of the metadata record is printed to stdout.
StoreFile interprets the time in metadata arguments as local time zone unless the T..Z format indicating UTC is used. For example, 1952-10-27T00:30:29.999Z.
-m <name>=<value>
Any number of -m options can be specified. Each -m option specifies a single (name,value) pair.
<name> should be specified in the format <namespace>.<attribute>. Use double quotes if <value> is a string containing spaces.
-h
Print this message.
java StoreFile 10.152.0.12 myFile java StoreFile server myFile.jpg \ -m filesystem.mimetype="image/jpeg" java StoreFile server myFile \ -m system.test.type_char="do re mi" java StoreFile server myFile \ -m system.test.type_string="fa so la" java StoreFile server myFile \ -m system.test.type_long=123 java StoreFile server myFile \ -m system.test.type_double=1.23 java StoreFile server myFile \ -m system.test.type_binary=0789abcdef java StoreFile server myFile \ -m system.test.type_date=2010-10-20 java StoreFile server myFile \ -m system.test.type_time=23:30:29 java StoreFile server myFile \ -m system.test.type_timestamp="2010-10-20 23:30:29.999" java StoreFile server myFile \ -m name1=value1 -m name2="value 2"
java/examples/StoreFile.java
Ensure an object can be queried. Checks if the metadata for an object is present in the query engine, and inserts the metadata if it is not present.
java CheckIndexed <IP | HOST> <OID> [OPTIONS]
Check with the 5800 systemserver to determine if the specified OID has become queryable. If not, attempt to make it queryable.
A short message about the supplied OID is printed to stdout:
Object OID was already queryable. Object OID not yet queryable. Object OID has now been made queryable. |
-h
Print this message.
java CheckIndexed server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 java CheckIndexed 10.152.0.12 \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
java/examples/CheckIndex.java
Retrieves data from a 5800 system server.
java RetrieveData <IP | HOST> <OID> [FILE] [OPTIONS]
Retrieves data from the 5800 system. The OID specifies what data to retrieve. Data is written to FILE, if specified, otherwise to stdout.
-h
Print this message.
java RetrieveData archivehost \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ /archive/log.1 java RetrieveData 10.152.0.12 \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ /archive/log.2
java/examples/RetrieveData.java
Retrieves metadata from the 5800 system. The OID specifies what data to retrieve.
By default, RetrieveMetadata displays the time according to the configuration of the client machine, including its time zone.
java RetrieveMetadata <IP | HOST> <OID> [OPTIONS]
Retrieves a data record and metadata from the 5800 system server. The metadata record identified by the supplied OID is printed to stdout.
-h
Print this message.
java RetrieveMetadata 10.152.0.12 \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
java/examples/RetrieveMetadata.java
Adds a metadata record to an already stored object.
java AddMetadata <IP | HOST> <OID> [OPTIONS]
Adds a new metadata record to an existing data object.
-m <name>=<value>
Any number of -m options can be specified. Each option specifies a single (name, value) pair.
<name> should be specified in the format <namespace>.<attribute>. Use double quotes if <value> is a string containing spaces.
-h
Print this message.
java AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m filesystem.mimetype="image/jpeg" java AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_char="do re mi" java AddMetadata server 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_string="fa so la" java AddMetadata server 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_long=123 java AddMetadata server 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_double=1.23 java AddMetadata server 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_date=1952-10-27 java AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_time=23:30:29 java AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m system.test.type_timestamp="1952-10-27 23:30:29.999" java AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000@ \ -m name1=value1 -m name2="value 2"
java/examples/AddMetadata.java
Deletes the Sun 5800 system metadata record associated with an OID.
java DeleteRecord <IP | Host> <OID> [OPTIONS]
Deletes the record with the specified OID. If this record is the only record pointing to the data, the data will also be deleted.
-v
Print deleted OID to stdout.
-h
Print this message.
java DeleteRecord server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
java/examples/DeleteRecord.java
Queries a 5800 system server for metadata records that match the query string passed on the command line.
Query requires the T..Z UTC format. For example, 1952-10-27T00:30:29.999Z.
java Query <IP | HOST> <QUERY> [OPTIONS]
Queries for metadata records. QUERY is of the form:
<name1>=’<value1>’ AND <name2>=’<value2>’ OR ...
See the examples below for formatting of various types of values. The OID and any specified fields of metadata records that match the query are printed to stdout.
<name> should be specified in the format <namespace>.<attribute>.
Note that names that are keywords need to be enclosed in escaped double quotes (for example, with the bash shell, use "\"<name>\"=’<value>’"). Refer to the list of keywords in Chapter 4, Sun StorageTek 5800 System Query Language, in Sun StorageTek 5800 SystemClient API Reference Manual.
-s <FIELD>
Specifies a field to be retrieved, much like an SQL select clause. To retrieve multiple fields, repeat this option. By default, the results are returned as a list of OIDs.
-n <number of results>
The maximum number of metadata records or OIDs that will be returned. The default is 1000.
-h
Print this message.
In the following examples, “first” is a keyword.
java Query server "book.author=’King’" java Query server "\"first\"=’a’" java Query 10.152.0.12 "mp3.artist=’The Beatles’ AND mp3.album=’Abbey Road’" java Query 10.152.0.12 "mp3.artist=’The Beatles’" -s mp3.album -s mp3.title java Query 10.152.0.12 system.test.type_char="’do re mi’" java Query 10.152.0.12 system.test.type_string="’fa so la’" java Query 10.152.0.12 system.test.type_long=123 java Query 10.152.0.12 system.test.type_double=1.23 java Query 10.152.0.12 system.test.type_binary="x’0789abcdef’" java Query 10.152.0.12 system.test.type_date="’2010-10-20’" java Query 10.152.0.12 system.test.type_time="’23:30:29’" java Query 10.152.0.12 system.test.type_timestamp="{timestamp’2010-10-20T23:30:29.123Z’}"
java/examples/Query.java
Returns the schema defined on a 5800 system server to standard output.
java RetrieveSchema [OPTIONS] <IP | HOST>
Retrieves the metadata schema from a 5800 system server, printing it to stdout.
-h
Print this message.
java RetrieveSchema archivehost
java/examples/RetrieveSchema.java
Gets the date.
java GetDate <IP | HOST> [OPTIONS]
Gets the current date used to compute time setting and checking during store and delete operations.
-h
Print this message.
java GetDate server
java/examples/GetDate.java
This section provides detailed information on the C example applications provided with the 5800 system client SDK.
Included with the 5800 system SDK are several command-line example applications that demonstrate the use of the C API. The example applications are located in the SDK under c/examples. Appropriate libraries are supplied for Solaris SPARC, Solaris x86, Red Hat Linux, and Windows.
Make sure you configure your software environment before using the C example applications.
In Solaris and Linux, set the LD_LIBRARY_PATH environment variable to SDK directory name/c/OS/lib where SDK directory name is the root directory of the unzipped 5800 system SDK archive and OS is either Solaris or Linux. For example:
StorageTek500_SDK_1_1-20/c/Solaris/lib
In Microsoft Windows 2003:
The example programs will run if they are run as installed in the default build directory. However, if you have moved them elsewhere, the location of the library files (DLLs) must be added to the PATH environment variable as follows:
C:\StorageTek500_SDK_1_1_82\c\Win32\lib
To edit the windows PATH environment variable:
Click the Start button.
Right-click My Computer and select properties to launch System Properties.
Click the Advanced tab.
Click Environment Variables.
Under System Variables, scroll down and click Path.
Click Edit to launch Edit System Variable.
Add the full path name of the SDK lib directory to the PATH environment variable. Make certain each path name is separated by a semicolon (;).
Click OK to close each window.
Also see Software Requirements.
To build the C example applications, go to the c/examples directory and run make. This will build the example applications and put them in the c/examples/OS/build directory.
Each C example application can be built separately by running make program_name.
Once you have built the C example applications, go to the c/examples/<OS>/build directory and execute the binary file with the appropriate command line. The examples depend on libhoneycomb.so.
First, the function parseCommandline is called to parse the command line and store the information in a struct called Commandline. Next, any files that contain data to be sent to the 5800 system server are opened. The appropriate 5800 system C API is then called. Finally, output is delivered back to either standard output, a file, or both. Refer to the comments in the sample code for further details.
The following C example applications are included with the 5800 system client SDK:
Stores a file and associated metadata on a 5800 system server.
StoreFile <IP | HOST> <FILE> [OPTIONS]
Stores a file and its associated metadata record. If no -m options are specified, a metadata record without user content is generated. The OID of the metadata record is printed to stdout.
-m <name>=<value>
Any number of -m options can be specified. Each option specifies a single (name,value) pair.
<name> should be specified in the format <namespace>.<attribute>. Use double quotes if <value> is a string containing spaces.
-h
Print this message.
StoreFile server /var/log/messages StoreFile server ~/journal StoreFile server myfile.jpg -m filesystem.mimetype="image/jpeg" StoreFile 10.152.0.12 myfile -m system.test.type_char="do re mi" StoreFile 10.152.0.12 myfile -m system.test.type_string="fa so la" StoreFile 10.152.0.12 myfile -m system.test.type_long=123 StoreFile 10.152.0.12 myfile -m system.test.type_double=1.23 StoreFile 10.152.0.12 myfile -m system.test.type_binary=0789abcdef StoreFile 10.152.0.12 myfile -m system.test.type_date=2010-10-20 StoreFile 10.152.0.12 myfile -m system.test.type_time=23:30:29 StoreFile 10.152.0.12 myfile \ -m system.test.type_timestamp="2010-10-20T23:30:29.999" StoreFile 10.152.0.12 myfile -m name1=value1 -m name2="value 2"
c/examples/StoreFile.c
Ensure an object is queryable. Checks if the metadata for an object is present in the query engine, and inserts the metadata if it is not present.
CheckIndexed <IP | HOST> <OID> [OPTIONS]
Check with the 5800 systemserver to determine if the specified OID has become queryable. If not, attempt to make it queryable.
A short message about the supplied OID is printed to stdout:
Object OID was already queryable. Object OID not yet queryable. Object OID has now been made queryable. |
-h
Print this message.
CheckIndexed archivehost \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 CheckIndexed 10.152.0.12 \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
c/examples/CheckIndexed.c
Retrieves a data object from a 5800 system server.
RetrieveData <IP | HOST> <OID> <FILE> [OPTIONS]
Retrieves data from the 5800 system. The OID specifies what data to retrieve. Data is written to FILE, if specified, otherwise to stdout.
-h
Print this message.
RetrieveData storagetek \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ /archive/log.1
c/examples/RetrieveData.c
Retrieves a metadata record from a specified 5800 system server.
RetrieveMetadata <IP | HOST> <OID> [OPTIONS]
Retrieves metadata from the 5800 system. The OID specifies what data to retrieve. Metadata is printed to stdout.
-h
Print this message.
RetrieveMetadata archivehost \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 RetrieveMetadata 10.152.0.12 \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
c/examples/RetrieveMetadata.c
Adds a metadata record to an already stored object.
AddMetadata <IP | HOST> <OID> [OPTIONS]
Adds a new metadata record to an existing data object.
-m <name>=<value>
Any number of -m options can be specified. Each option specifies a single (name, value) pair.
<name> should be specified in the format <namespace>.<attribute>. Use double quotes if <value> is a string containing spaces.
-h
Print this message.
AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m filesystem.mimetype="image/jpeg" AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_char="do re mi" AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_string="fa so la" AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_long=123 AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_double=1.23 AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_date=1992-10-27 AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_time=23:30:29 AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m system.test.type_timestamp="1992-10-27T23:30:29" AddMetadata server \ 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000 \ -m name1=value1 -m name2="value 2"
c/examples/AddMetadata.c
Deletes a record associated with an OID.
DeleteRecord <IP | HOST> <OID> [OPTIONS]
Deletes a record associated with an OID. The OID specifies which record to delete. The record consists of all metadata associated with the OID, or the data if it is a data OID. The OID itself becomes inaccessible. If this OID is the last OID associated with the data, the data is also deleted.
-v
Print deleted OID to stdout.
-h
Print this message.
DeleteRecord server 0200004f75ee01094cc13e11dbbad000e08159832d000024d40200000000
c/examples/DeleteRecord.c
Queries a 5800 system server for metadata records that match the query string passed on the command line.
Query requires the T..Z UTC format. For example, 1952-10-27T00:30:29.999Z.
Query <IP | HOST> <QUERY> [OPTIONS]
Queries for metadata records. QUERY is of the form:
<name1>=’<value1>’ AND <name2>=’<value2>’ OR ...
See the examples below for formatting of various types of values. The OID and any specified fields of metadata records that match the query are printed to stdout.
<name> should be specified in the format <namespace>.<attribute>.
Note that names that are keywords need to be enclosed in escaped double quotes (for example, with the bash shell, use "\"<name>\"=’<value>’"). Refer to the list of keywords in Chapter 4, Sun StorageTek 5800 System Query Language, in Sun StorageTek 5800 SystemClient API Reference Manual.
-s <FIELD>
Print out results as metadata name-value records. Use as many -s switches as needed to define all fields that will be printed to stdout.
-n <number of results>
The maximum number of metadata records or OIDs that will be returned. The default is 1000.
-h
Print this message.
In the following examples, “first” is a keyword.
Query archivehost "book.author=’King’" Query archivehost "\"first\"=’a’" Query archivehost system.test.type_char="’do re mi’" Query archivehost system.test.type_string="’fa so la’" Query archivehost system.test.type_long=123 Query archivehost system.test.type_double=1.23 Query archivehost system.test.type_binary="x’0789abcdef’" Query archivehost system.test.type_date="’2010-10-20’" Query archivehost system.test.type_time="’22:10:29’" Query archivehost system.test.type_timestamp="{timestamp’2010-10-20T23:30:29.123Z’}" Query 10.152.0.12 "mp3.artist=’The Beatles’ AND mp3.album=’Abbey Road’" Query 10.152.0.12 "mp3.artist=’The Beatles’" -s mp3.album -s mp3.title Query 10.152.0.12 "system.test.type_timestamp={timestamp ’1952-10-27T08:30:29.999Z’}"
c/examples/Query.c
Prints metadata attributes to stdout.
RetrieveSchema <IP | HOST> [OPTIONS]
Retrieves the schema from a 5800 system server, printing it to stdout.
-h
Print this message.
RetrieveSchema archivehost
c/examples/RetrieveSchema.c