Package com.perforce.p4java.core

Interface IExtension

All Superinterfaces:

IExtensionSummary, IServerResource

All Known Implementing Classes:

Extension

public interface IExtension
extends IServerResource, IExtensionSummary

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 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 Details

getExtDescription

String getExtDescription()

Get the description of the Extension being configured.

Returns:

Extension description

getExtMaxScriptTime

String getExtMaxScriptTime()

Get maximum seconds the Extension may be run.

Returns:

possibly-null (optional) Maximum seconds

getExtMaxScriptMem

String getExtMaxScriptMem()

Get maximum megabytes the Extension may use.

Returns:

possibly-null (optional) Maximum megabytes

getOwner

String getOwner()

Get the user who created this Extension config.

Returns:

Owner

getUpdate

String getUpdate()

Get update time for the Extension config spec.

Returns:

Update time

getDescription

String getDescription()

Get the description of this Extension config.

Returns:

Extension config description

getExtConfig

Map<String,String> getExtConfig()

Get the extension config.

Returns:

Extension config

getExtAllowedGroups

List<String> getExtAllowedGroups()

Get groups whose members may configure the Extension.

Returns:

Allowed groups

getExtP4USER

String getExtP4USER()

Get Perforce user account for the Extension to use.

Returns:

User

getExtDebug

String getExtDebug()

Check if extension diagnostics are enabled.

Returns:

Extension debug

setExtDescription

void setExtDescription(String extDescription)

Set the description of the Extension being configured.

Parameters:

extDescription - description

setExtMaxScriptTime

void setExtMaxScriptTime(String extMaxScriptTime)

Set maximum seconds the Extension may be run.

Parameters:

extMaxScriptTime - time

setExtMaxScriptMem

void setExtMaxScriptMem(String extMaxScriptMem)

Set maximum megabytes the Extension may use.

Parameters:

extMaxScriptMem - memory

setOwner

void setOwner(String owner)

Set the user who created this Extension config.

Parameters:

owner - owner

setUpdate

void setUpdate(String update)

Set update time for the Extension config spec.

Parameters:

update - date

setDescription

void setDescription(String description)

Set the description of this Extension config.

Parameters:

description - description

setExtConfig

void setExtConfig(Map<String,String> extConfig)

Set the extension config.

Parameters:

extConfig - config map

setExtAllowedGroups

void setExtAllowedGroups(List<String> extAllowedGroups)

Set groups whose members may configure the Extension.

Parameters:

extAllowedGroups - groups

setExtP4USER

void setExtP4USER(String extP4USER)

Set Perforce user account for the Extension to use.

Parameters:

extP4USER - Perforce user

setExtDebug

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.

Parameters:

extDebug - debug