Class Extension
- java.lang.Object
-
- com.perforce.p4java.impl.generic.core.ServerResource
-
- com.perforce.p4java.impl.generic.core.ExtensionSummary
-
- com.perforce.p4java.impl.generic.core.Extension
-
- All Implemented Interfaces:
IExtension,IServerResource,IExtensionSummary
public class Extension extends ExtensionSummary implements IExtension
-
-
Field Summary
-
Fields inherited from class com.perforce.p4java.impl.generic.core.ExtensionSummary
extEnabled, extName, extRev, extUUID, extVersion, nameSpace
-
Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
refreshable, server, updateable
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDescription()Get the description of this Extension config.java.util.List<java.lang.String>getExtAllowedGroups()Get groups whose members may configure the Extension.java.util.Map<java.lang.String,java.lang.String>getExtConfig()Get the extension config.java.lang.StringgetExtDebug()Check if extension diagnostics are enabled.java.lang.StringgetExtDescription()Get the description of the Extension being configured.java.lang.StringgetExtMaxScriptMem()Get maximum megabytes the Extension may use.java.lang.StringgetExtMaxScriptTime()Get maximum seconds the Extension may be run.java.lang.StringgetExtP4USER()Get Perforce user account for the Extension to use.java.lang.StringgetOwner()Get the user who created this Extension config.java.lang.StringgetUpdate()Get update time for the Extension config spec.voidsetDescription(java.lang.String description)Set the description of this Extension config.voidsetExtAllowedGroups(java.util.List<java.lang.String> extAllowedGroups)Set groups whose members may configure the Extension.voidsetExtConfig(java.util.Map<java.lang.String,java.lang.String> extConfig)Set the extension config.voidsetExtDebug(java.lang.String extDebug)When the 'ExtDebug' field in the instance config is set to 'tracing' (off of the default of 'none'), every execution of the instance of the Extension will append execution traces to a log file named '.p4-debug-tracing.txt' in the Extension data directory.voidsetExtDescription(java.lang.String extDescription)Set the description of the Extension being configured.voidsetExtMaxScriptMem(java.lang.String extMaxScriptMem)Set maximum megabytes the Extension may use.voidsetExtMaxScriptTime(java.lang.String extMaxScriptTime)Set maximum seconds the Extension may be run.voidsetExtP4USER(java.lang.String extP4USER)Set Perforce user account for the Extension to use.voidsetOwner(java.lang.String owner)Set the user who created this Extension config.voidsetUpdate(java.lang.String update)Set update time for the Extension config spec.-
Methods inherited from class com.perforce.p4java.impl.generic.core.ExtensionSummary
getExtArchDir, getExtDataDir, getExtDescriptionSnippet, getExtDeveloper, getExtEnabled, getExtGlobalConf, getExtInstanceConf, getExtName, getExtRev, getExtUUID, getExtVersion, getNameSpace, setExtArchDir, setExtDataDir, setExtDescriptionSnippet, setExtDeveloper, setExtEnabled, setExtGlobalConf, setExtInstanceConf, setExtName, setExtRev, setExtUUID, setExtVersion, setNameSpace
-
Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, parseDate, refresh, setRawField, setRawFields, setRefreshable, setServer, toDateString, update, update, update
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.perforce.p4java.impl.generic.core.file.IExtensionSummary
getExtArchDir, getExtDataDir, getExtDescriptionSnippet, getExtDeveloper, getExtEnabled, getExtGlobalConf, getExtInstanceConf, getExtName, getExtRev, getExtUUID, getExtVersion, getNameSpace, setExtArchDir, setExtDataDir, setExtDescriptionSnippet, setExtDeveloper, setExtEnabled, setExtGlobalConf, setExtInstanceConf, setExtName, setExtRev, setExtUUID, setExtVersion, setNameSpace
-
Methods inherited from interface com.perforce.p4java.core.IServerResource
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update
-
-
-
-
Method Detail
-
getExtDescription
public java.lang.String getExtDescription()
Description copied from interface:IExtensionGet the description of the Extension being configured.- Specified by:
getExtDescriptionin interfaceIExtension- Returns:
- Extension description
-
getExtMaxScriptTime
public java.lang.String getExtMaxScriptTime()
Description copied from interface:IExtensionGet maximum seconds the Extension may be run.- Specified by:
getExtMaxScriptTimein interfaceIExtension- Returns:
- possibly-null (optional) Maximum seconds
-
getExtMaxScriptMem
public java.lang.String getExtMaxScriptMem()
Description copied from interface:IExtensionGet maximum megabytes the Extension may use.- Specified by:
getExtMaxScriptMemin interfaceIExtension- Returns:
- possibly-null (optional) Maximum megabytes
-
getOwner
public java.lang.String getOwner()
Description copied from interface:IExtensionGet the user who created this Extension config.- Specified by:
getOwnerin interfaceIExtension- Returns:
- Owner
-
getUpdate
public java.lang.String getUpdate()
Description copied from interface:IExtensionGet update time for the Extension config spec.- Specified by:
getUpdatein interfaceIExtension- Returns:
- Update time
-
getDescription
public java.lang.String getDescription()
Description copied from interface:IExtensionGet the description of this Extension config.- Specified by:
getDescriptionin interfaceIExtension- Returns:
- Extension config description
-
getExtConfig
public java.util.Map<java.lang.String,java.lang.String> getExtConfig()
Description copied from interface:IExtensionGet the extension config.- Specified by:
getExtConfigin interfaceIExtension- Returns:
- Extension config
-
getExtAllowedGroups
public java.util.List<java.lang.String> getExtAllowedGroups()
Description copied from interface:IExtensionGet groups whose members may configure the Extension.- Specified by:
getExtAllowedGroupsin interfaceIExtension- Returns:
- Allowed groups
-
getExtP4USER
public java.lang.String getExtP4USER()
Description copied from interface:IExtensionGet Perforce user account for the Extension to use.- Specified by:
getExtP4USERin interfaceIExtension- Returns:
- User
-
getExtDebug
public java.lang.String getExtDebug()
Description copied from interface:IExtensionCheck if extension diagnostics are enabled.- Specified by:
getExtDebugin interfaceIExtension- Returns:
- Extension debug
-
setExtDescription
public void setExtDescription(java.lang.String extDescription)
Description copied from interface:IExtensionSet the description of the Extension being configured.- Specified by:
setExtDescriptionin interfaceIExtension- Parameters:
extDescription- description
-
setExtMaxScriptTime
public void setExtMaxScriptTime(java.lang.String extMaxScriptTime)
Description copied from interface:IExtensionSet maximum seconds the Extension may be run.- Specified by:
setExtMaxScriptTimein interfaceIExtension- Parameters:
extMaxScriptTime- time
-
setExtMaxScriptMem
public void setExtMaxScriptMem(java.lang.String extMaxScriptMem)
Description copied from interface:IExtensionSet maximum megabytes the Extension may use.- Specified by:
setExtMaxScriptMemin interfaceIExtension- Parameters:
extMaxScriptMem- memory
-
setOwner
public void setOwner(java.lang.String owner)
Description copied from interface:IExtensionSet the user who created this Extension config.- Specified by:
setOwnerin interfaceIExtension- Parameters:
owner- owner
-
setUpdate
public void setUpdate(java.lang.String update)
Description copied from interface:IExtensionSet update time for the Extension config spec.- Specified by:
setUpdatein interfaceIExtension- Parameters:
update- date
-
setDescription
public void setDescription(java.lang.String description)
Description copied from interface:IExtensionSet the description of this Extension config.- Specified by:
setDescriptionin interfaceIExtension- Parameters:
description- description
-
setExtConfig
public void setExtConfig(java.util.Map<java.lang.String,java.lang.String> extConfig)
Description copied from interface:IExtensionSet the extension config.- Specified by:
setExtConfigin interfaceIExtension- Parameters:
extConfig- config map
-
setExtAllowedGroups
public void setExtAllowedGroups(java.util.List<java.lang.String> extAllowedGroups)
Description copied from interface:IExtensionSet groups whose members may configure the Extension.- Specified by:
setExtAllowedGroupsin interfaceIExtension- Parameters:
extAllowedGroups- groups
-
setExtP4USER
public void setExtP4USER(java.lang.String extP4USER)
Description copied from interface:IExtensionSet Perforce user account for the Extension to use.- Specified by:
setExtP4USERin interfaceIExtension- Parameters:
extP4USER- Perforce user
-
setExtDebug
public void setExtDebug(java.lang.String extDebug)
Description copied from interface:IExtensionWhen the 'ExtDebug' field in the instance config is set to 'tracing' (off of the default of 'none'), every execution of the instance of the Extension will append execution traces to a log file named '.p4-debug-tracing.txt' in the Extension data directory.- Specified by:
setExtDebugin interfaceIExtension- Parameters:
extDebug- debug
-
-