Package com.perforce.p4java.impl.generic.core

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

Constructor Summary

Constructors

Constructor	Description
Extension()
Extension(Map<String,Object> map)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description of this Extension config.
List<String>	getExtAllowedGroups()	Get groups whose members may configure the Extension.
Map<String,String>	getExtConfig()	Get the extension config.
String	getExtDebug()	Check if extension diagnostics are enabled.
String	getExtDescription()	Get the description of the Extension being configured.
String	getExtMaxScriptMem()	Get maximum megabytes the Extension may use.
String	getExtMaxScriptTime()	Get maximum seconds the Extension may be run.
String	getExtP4USER()	Get Perforce user account for the Extension to use.
String	getOwner()	Get the user who created this Extension config.
String	getUpdate()	Get update time for the Extension config spec.
void	setDescription(String description)	Set the description of this Extension config.
void	setExtAllowedGroups(List<String> extAllowedGroups)	Set groups whose members may configure the Extension.
void	setExtConfig(Map<String,String> extConfig)	Set the extension config.
void	setExtDebug(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(String extDescription)	Set the description of the Extension being configured.
void	setExtMaxScriptMem(String extMaxScriptMem)	Set maximum megabytes the Extension may use.
void	setExtMaxScriptTime(String extMaxScriptTime)	Set maximum seconds the Extension may be run.
void	setExtP4USER(String extP4USER)	Set Perforce user account for the Extension to use.
void	setOwner(String owner)	Set the user who created this Extension config.
void	setUpdate(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

Constructor Details

Extension

public Extension()

Extension

public Extension(Map<String,Object> map)

Method Details

getExtDescription

public String getExtDescription()

Description copied from interface: IExtension

Get the description of the Extension being configured.

Specified by:

getExtDescription in interface IExtension

Returns:

Extension description

getExtMaxScriptTime

public String getExtMaxScriptTime()

Description copied from interface: IExtension

Get maximum seconds the Extension may be run.

Specified by:

getExtMaxScriptTime in interface IExtension

Returns:

possibly-null (optional) Maximum seconds

getExtMaxScriptMem

public String getExtMaxScriptMem()

Description copied from interface: IExtension

Get maximum megabytes the Extension may use.

Specified by:

getExtMaxScriptMem in interface IExtension

Returns:

possibly-null (optional) Maximum megabytes

getOwner

public String getOwner()

Description copied from interface: IExtension

Get the user who created this Extension config.

Specified by:

getOwner in interface IExtension

Returns:

Owner

getUpdate

public String getUpdate()

Description copied from interface: IExtension

Get update time for the Extension config spec.

Specified by:

getUpdate in interface IExtension

Returns:

Update time

getDescription

public String getDescription()

Description copied from interface: IExtension

Get the description of this Extension config.

Specified by:

getDescription in interface IExtension

Returns:

Extension config description

getExtConfig

public Map<String,String> getExtConfig()

Description copied from interface: IExtension

Get the extension config.

Specified by:

getExtConfig in interface IExtension

Returns:

Extension config

getExtAllowedGroups

public List<String> getExtAllowedGroups()

Description copied from interface: IExtension

Get groups whose members may configure the Extension.

Specified by:

getExtAllowedGroups in interface IExtension

Returns:

Allowed groups

getExtP4USER

public String getExtP4USER()

Description copied from interface: IExtension

Get Perforce user account for the Extension to use.

Specified by:

getExtP4USER in interface IExtension

Returns:

User

getExtDebug

public String getExtDebug()

Description copied from interface: IExtension

Check if extension diagnostics are enabled.

Specified by:

getExtDebug in interface IExtension

Returns:

Extension debug

setExtDescription

public void setExtDescription(String extDescription)

Description copied from interface: IExtension

Set the description of the Extension being configured.

Specified by:

setExtDescription in interface IExtension

Parameters:

extDescription - description

setExtMaxScriptTime

public void setExtMaxScriptTime(String extMaxScriptTime)

Description copied from interface: IExtension

Set maximum seconds the Extension may be run.

Specified by:

setExtMaxScriptTime in interface IExtension

Parameters:

extMaxScriptTime - time

setExtMaxScriptMem

public void setExtMaxScriptMem(String extMaxScriptMem)

Description copied from interface: IExtension

Set maximum megabytes the Extension may use.

Specified by:

setExtMaxScriptMem in interface IExtension

Parameters:

extMaxScriptMem - memory

setOwner

public void setOwner(String owner)

Description copied from interface: IExtension

Set the user who created this Extension config.

Specified by:

setOwner in interface IExtension

Parameters:

owner - owner

setUpdate

public void setUpdate(String update)

Description copied from interface: IExtension

Set update time for the Extension config spec.

Specified by:

setUpdate in interface IExtension

Parameters:

update - date

setDescription

public void setDescription(String description)

Description copied from interface: IExtension

Set the description of this Extension config.

Specified by:

setDescription in interface IExtension

Parameters:

description - description

setExtConfig

public void setExtConfig(Map<String,String> extConfig)

Description copied from interface: IExtension

Set the extension config.

Specified by:

setExtConfig in interface IExtension

Parameters:

extConfig - config map

setExtAllowedGroups

public void setExtAllowedGroups(List<String> extAllowedGroups)

Description copied from interface: IExtension

Set groups whose members may configure the Extension.

Specified by:

setExtAllowedGroups in interface IExtension

Parameters:

extAllowedGroups - groups

setExtP4USER

public void setExtP4USER(String extP4USER)

Description copied from interface: IExtension

Set Perforce user account for the Extension to use.

Specified by:

setExtP4USER in interface IExtension

Parameters:

extP4USER - Perforce user

setExtDebug

public void setExtDebug(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 interface IExtension

Parameters:

extDebug - debug