com.softwareag.tamino.db.api.accessor
Interface TAdministrationAccessor

All Superinterfaces:
TAccessor, TInvalidatableAccessor
All Known Implementing Classes:
TAdministrationAccessorImpl, TAdministrationAccessorTimeLoggingImpl

public interface TAdministrationAccessor
extends TAccessor

TAdministrationAccessor is the interface for the execution of Tamino administration functions. This accessor currently consists of a single generic method.

Version:
$Revision: 1.3 $
Author:
Stefan Liebig

Method Summary
 TInputStream execute(java.lang.String commandValue)
          Executes a Tamino administrative command.
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TAccessor
cancelRequests, getAccessLocation, getApplicationName, getCanBeCancelled, getLockMode, getLockwaitMode, getMaximumRequestDuration, setAccessLocation, setApplicationName, setCanBeCancelled, setLockMode, setLockwaitMode, setMaximumRequestDuration
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TInvalidatableAccessor
invalidate
 

Method Detail

execute

TInputStream execute(java.lang.String commandValue)
                     throws TAccessorException
Executes a Tamino administrative command. The adminstration function to be executed is specified as a String. The Tamino response document is returned as a TINputStream.

Parameters:
commandValue - a String representing the Tamino administration function, e.g. "ino:RecreateIndex(myCollection,Mydoctype)".
Returns:
TInputstream the raw and unparsed Tamino answer.
Throws:
TAccessorException - signals an error while executimg the command.


Copyright (c) 2013 Software AG. All Rights Reserved.