com.softwareag.tamino.db.api.accessor
Class TAdministrationAccessorImpl

java.lang.Object
  extended by com.softwareag.tamino.db.api.accessor.TAbstractAccessor
      extended by com.softwareag.tamino.db.api.accessor.TAdministrationAccessorImpl
All Implemented Interfaces:
TAccessor, TAdministrationAccessor, TInvalidatableAccessor
Direct Known Subclasses:
TAdministrationAccessorTimeLoggingImpl

public class TAdministrationAccessorImpl
extends TAbstractAccessor
implements TAdministrationAccessor

TAdministrationAccessorImpl is the implementation class for TAdministrationAccessor.

Version:
$Revision: 1.7 $
Author:
Stefan Liebig

Field Summary
 
Fields inherited from class com.softwareag.tamino.db.api.accessor.TAbstractAccessor
canBeCancelled, clientRequests, requestCounter, SGUAI
 
Constructor Summary
TAdministrationAccessorImpl(TStreamAccessor streamAccessor, TResponseBuilder responseBuilder)
          Special Constructor.
 
Method Summary
 void cancelRequests()
          Cancels all requests issued using current accessor.
 TInputStream execute(java.lang.String commandValue)
          Execute an administrative command with the given command value and return the result as a raw input stream.
 java.lang.String getApplicationName()
          Returns Client Application Name
 void setApplicationName(java.lang.String applicationName)
          Sets Client Application Name.
 void setCanBeCancelled(boolean canBeCancelled)
          Sets whether request can be canBeCancelled.
 
Methods inherited from class com.softwareag.tamino.db.api.accessor.TAbstractAccessor
getAccessCollection, getAccessLocation, getCanBeCancelled, getDatabaseUri, getInvocation, getLocale, getLockMode, getLockwaitMode, getMaximumRequestDuration, invalidate, invoke, invoke, invoke, setAccessLocation, setInvocation, setLockMode, setLockwaitMode, setMaximumRequestDuration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TAccessor
getAccessLocation, getCanBeCancelled, getLockMode, getLockwaitMode, getMaximumRequestDuration, setAccessLocation, setLockMode, setLockwaitMode, setMaximumRequestDuration
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TInvalidatableAccessor
invalidate
 

Constructor Detail

TAdministrationAccessorImpl

public TAdministrationAccessorImpl(TStreamAccessor streamAccessor,
                                   TResponseBuilder responseBuilder)
Special Constructor. Initializes the accessor with the given TCommandInvocation and TResponseBuilder.

Parameters:
streamAccessor - to use for the invocations
responseBuilder - to use for building the response
Method Detail

execute

public TInputStream execute(java.lang.String commandValue)
                     throws TAccessorException
Execute an administrative command with the given command value and return the result as a raw input stream.

Specified by:
execute in interface TAdministrationAccessor
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.

setCanBeCancelled

public void setCanBeCancelled(boolean canBeCancelled)
                       throws TAdminException
Sets whether request can be canBeCancelled.

Specified by:
setCanBeCancelled in interface TAccessor
Overrides:
setCanBeCancelled in class TAbstractAccessor
Throws:
TAdminException

cancelRequests

public void cancelRequests()
                    throws TAdminException
Cancels all requests issued using current accessor.

Specified by:
cancelRequests in interface TAccessor
Overrides:
cancelRequests in class TAbstractAccessor
Throws:
TAdminException

setApplicationName

public void setApplicationName(java.lang.String applicationName)
Sets Client Application Name.

Specified by:
setApplicationName in interface TAccessor
Overrides:
setApplicationName in class TAbstractAccessor

getApplicationName

public java.lang.String getApplicationName()
Returns Client Application Name

Specified by:
getApplicationName in interface TAccessor
Overrides:
getApplicationName in class TAbstractAccessor


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