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.String
getDescription()
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.String
getExtDebug()
Check if extension diagnostics are enabled.java.lang.String
getExtDescription()
Get the description of the Extension being configured.java.lang.String
getExtMaxScriptMem()
Get maximum megabytes the Extension may use.java.lang.String
getExtMaxScriptTime()
Get maximum seconds the Extension may be run.java.lang.String
getExtP4USER()
Get Perforce user account for the Extension to use.java.lang.String
getOwner()
Get the user who created this Extension config.java.lang.String
getUpdate()
Get update time for the Extension config spec.void
setDescription(java.lang.String description)
Set the description of this Extension config.void
setExtAllowedGroups(java.util.List<java.lang.String> extAllowedGroups)
Set groups whose members may configure the Extension.void
setExtConfig(java.util.Map<java.lang.String,java.lang.String> extConfig)
Set the extension config.void
setExtDebug(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.void
setExtDescription(java.lang.String extDescription)
Set the description of the Extension being configured.void
setExtMaxScriptMem(java.lang.String extMaxScriptMem)
Set maximum megabytes the Extension may use.void
setExtMaxScriptTime(java.lang.String extMaxScriptTime)
Set maximum seconds the Extension may be run.void
setExtP4USER(java.lang.String extP4USER)
Set Perforce user account for the Extension to use.void
setOwner(java.lang.String owner)
Set the user who created this Extension config.void
setUpdate(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:IExtension
Get the description of the Extension being configured.- Specified by:
getExtDescription
in interfaceIExtension
- Returns:
- Extension description
-
getExtMaxScriptTime
public java.lang.String getExtMaxScriptTime()
Description copied from interface:IExtension
Get maximum seconds the Extension may be run.- Specified by:
getExtMaxScriptTime
in interfaceIExtension
- Returns:
- possibly-null (optional) Maximum seconds
-
getExtMaxScriptMem
public java.lang.String getExtMaxScriptMem()
Description copied from interface:IExtension
Get maximum megabytes the Extension may use.- Specified by:
getExtMaxScriptMem
in interfaceIExtension
- Returns:
- possibly-null (optional) Maximum megabytes
-
getOwner
public java.lang.String getOwner()
Description copied from interface:IExtension
Get the user who created this Extension config.- Specified by:
getOwner
in interfaceIExtension
- Returns:
- Owner
-
getUpdate
public java.lang.String getUpdate()
Description copied from interface:IExtension
Get update time for the Extension config spec.- Specified by:
getUpdate
in interfaceIExtension
- Returns:
- Update time
-
getDescription
public java.lang.String getDescription()
Description copied from interface:IExtension
Get the description of this Extension config.- Specified by:
getDescription
in interfaceIExtension
- Returns:
- Extension config description
-
getExtConfig
public java.util.Map<java.lang.String,java.lang.String> getExtConfig()
Description copied from interface:IExtension
Get the extension config.- Specified by:
getExtConfig
in interfaceIExtension
- Returns:
- Extension config
-
getExtAllowedGroups
public java.util.List<java.lang.String> getExtAllowedGroups()
Description copied from interface:IExtension
Get groups whose members may configure the Extension.- Specified by:
getExtAllowedGroups
in interfaceIExtension
- Returns:
- Allowed groups
-
getExtP4USER
public java.lang.String getExtP4USER()
Description copied from interface:IExtension
Get Perforce user account for the Extension to use.- Specified by:
getExtP4USER
in interfaceIExtension
- Returns:
- User
-
getExtDebug
public java.lang.String getExtDebug()
Description copied from interface:IExtension
Check if extension diagnostics are enabled.- Specified by:
getExtDebug
in interfaceIExtension
- Returns:
- Extension debug
-
setExtDescription
public void setExtDescription(java.lang.String extDescription)
Description copied from interface:IExtension
Set the description of the Extension being configured.- Specified by:
setExtDescription
in interfaceIExtension
- Parameters:
extDescription
- description
-
setExtMaxScriptTime
public void setExtMaxScriptTime(java.lang.String extMaxScriptTime)
Description copied from interface:IExtension
Set maximum seconds the Extension may be run.- Specified by:
setExtMaxScriptTime
in interfaceIExtension
- Parameters:
extMaxScriptTime
- time
-
setExtMaxScriptMem
public void setExtMaxScriptMem(java.lang.String extMaxScriptMem)
Description copied from interface:IExtension
Set maximum megabytes the Extension may use.- Specified by:
setExtMaxScriptMem
in interfaceIExtension
- Parameters:
extMaxScriptMem
- memory
-
setOwner
public void setOwner(java.lang.String owner)
Description copied from interface:IExtension
Set the user who created this Extension config.- Specified by:
setOwner
in interfaceIExtension
- Parameters:
owner
- owner
-
setUpdate
public void setUpdate(java.lang.String update)
Description copied from interface:IExtension
Set update time for the Extension config spec.- Specified by:
setUpdate
in interfaceIExtension
- Parameters:
update
- date
-
setDescription
public void setDescription(java.lang.String description)
Description copied from interface:IExtension
Set the description of this Extension config.- Specified by:
setDescription
in interfaceIExtension
- Parameters:
description
- description
-
setExtConfig
public void setExtConfig(java.util.Map<java.lang.String,java.lang.String> extConfig)
Description copied from interface:IExtension
Set the extension config.- Specified by:
setExtConfig
in interfaceIExtension
- Parameters:
extConfig
- config map
-
setExtAllowedGroups
public void setExtAllowedGroups(java.util.List<java.lang.String> extAllowedGroups)
Description copied from interface:IExtension
Set groups whose members may configure the Extension.- Specified by:
setExtAllowedGroups
in interfaceIExtension
- Parameters:
extAllowedGroups
- groups
-
setExtP4USER
public void setExtP4USER(java.lang.String extP4USER)
Description copied from interface:IExtension
Set Perforce user account for the Extension to use.- Specified by:
setExtP4USER
in interfaceIExtension
- Parameters:
extP4USER
- Perforce user
-
setExtDebug
public void setExtDebug(java.lang.String extDebug)
Description copied from interface:IExtension
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.- Specified by:
setExtDebug
in interfaceIExtension
- Parameters:
extDebug
- debug
-
-