com.plumtree.server
Interface IPTExternalOperation

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTExternalOperation
extends IPTObject

JHQ 050604: External Operations have been re-architected to run script files instead of commands from the command line. These scripts must reside in the automation server's portal_home/scripts directory. This directory can be secured as necessary. Therefore, we no longer use the RunAsUser/RunAsUserPassword. Corresponding methods will be deprecated and should not be implemented.

Version:
$Revision$
Author:
OlegS

Method Summary
 java.lang.String GetCommandLine()
          Retrieves the command line that is launched by this external operation.
 java.lang.String GetEncryptedPassword()
          Deprecated. This method should not be implemented.
 int GetTimeout()
          Gets the timeout for the command line in milliseconds
 java.lang.String GetUser()
          Deprecated. This method should not be implemented.
 void SetCommandLine(java.lang.String Value)
          Sets the command line that is launched by this external operation
 void SetPassword(java.lang.String Value)
          Deprecated. This method should not be implemented.
 void SetTimeout(int Value)
          Sets the timeout for the command line in milliseconds
 void SetUser(java.lang.String Value)
          Deprecated. This method should not be implemented.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetCommandLine

java.lang.String GetCommandLine()
Retrieves the command line that is launched by this external operation.

Returns:
a String containing the full command line (with parameters)

SetCommandLine

void SetCommandLine(java.lang.String Value)
Sets the command line that is launched by this external operation

Parameters:
Value - a String containing the full command line (with parameters)

GetUser

java.lang.String GetUser()
Deprecated. This method should not be implemented.

Returns the user under whose identity the command line is executed.

Returns:
a String containing the user name

SetUser

void SetUser(java.lang.String Value)
Deprecated. This method should not be implemented.

Sets the user under whose identity the command line is executed.

Parameters:
Value - a String containing the user name.

GetEncryptedPassword

java.lang.String GetEncryptedPassword()
Deprecated. This method should not be implemented.

Returns an encrypted version of the executing user's password

Returns:
a String containing the encripted user's password

SetPassword

void SetPassword(java.lang.String Value)
Deprecated. This method should not be implemented.

Sets the password used to authenticate the executing user.

Parameters:
Value - The user's password

GetTimeout

int GetTimeout()
Gets the timeout for the command line in milliseconds

Returns:
milliseconds before executable would be forcibly terminated

SetTimeout

void SetTimeout(int Value)
Sets the timeout for the command line in milliseconds

Parameters:
Value - milliseconds before executable would be forcibly terminated


Copyright 2008 Plumtree Software Inc. All Rights Reserved.