public class ExtensionDelegator extends BaseDelegator implements IExtensionDelegator
MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION
Constructor and Description |
---|
ExtensionDelegator(IOptionsServer server)
Basic constructor, taking a server object.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createExtensionConfig(IExtension extension,
java.lang.String namespace,
java.lang.String instanceConfig)
Creates/updates an extension's global/instance config.
|
java.lang.String |
deleteExtension(java.lang.String namespace,
java.lang.String extnName)
Deletes an extension along with all of its configuration.
|
Extension |
getExtensionConfig(java.lang.String namespace,
java.lang.String name,
java.lang.String instanceName)
Retrieves an extension/config.
|
ExtensionSummary |
installExtension(java.lang.String extnPackageName,
boolean allowUnsigned)
Installs extension on p4 server.
|
java.util.List<ExtensionSummary> |
listExtensions(java.lang.String type)
Lists extensions or configs based on type.
|
java.lang.String |
packageExtension(java.lang.String dirName)
Packages the extension.
|
java.lang.String |
sampleExtension(java.lang.String extnName)
Creates sample extension with the given name.
|
java.lang.String |
updateExtensionConfig(IExtension extension,
java.lang.String namespace,
java.lang.String instanceConfig)
Updates an extension's global/instance config.
|
public ExtensionDelegator(IOptionsServer server)
server
- - an instance of the currently effective server implementationpublic java.lang.String sampleExtension(java.lang.String extnName) throws P4JavaException
IExtensionDelegator
sampleExtension
in interface IExtensionDelegator
extnName
- - name of the extensionP4JavaException
public java.lang.String packageExtension(java.lang.String dirName) throws P4JavaException
IExtensionDelegator
packageExtension
in interface IExtensionDelegator
dirName
- - Directory name containing main.lua and manifest.json for the extensionP4JavaException
public ExtensionSummary installExtension(java.lang.String extnPackageName, boolean allowUnsigned) throws P4JavaException
IExtensionDelegator
installExtension
in interface IExtensionDelegator
extnPackageName
- - Name of the extension package file. For ex. p4java-obliterate-extn.p4-extensionP4JavaException
public java.lang.String createExtensionConfig(IExtension extension, java.lang.String namespace, @Nullable java.lang.String instanceConfig) throws P4JavaException
IExtensionDelegator
createExtensionConfig
in interface IExtensionDelegator
instanceConfig
- - If provided, creates/updates this instance config.P4JavaException
public java.lang.String updateExtensionConfig(IExtension extension, java.lang.String namespace, @Nullable java.lang.String instanceConfig) throws P4JavaException
IExtensionDelegator
updateExtensionConfig
in interface IExtensionDelegator
instanceConfig
- - If provided updates this instance config.P4JavaException
public java.util.List<ExtensionSummary> listExtensions(java.lang.String type) throws P4JavaException
IExtensionDelegator
listExtensions
in interface IExtensionDelegator
type
- - Can be "extensions" or "configs"P4JavaException
public java.lang.String deleteExtension(java.lang.String namespace, java.lang.String extnName) throws P4JavaException
IExtensionDelegator
deleteExtension
in interface IExtensionDelegator
P4JavaException
public Extension getExtensionConfig(java.lang.String namespace, java.lang.String name, java.lang.String instanceName) throws P4JavaException
IExtensionDelegator
getExtensionConfig
in interface IExtensionDelegator
instanceName
- Optional, only required for instance configP4JavaException
Copyright © 2022 Perforce Software. All Rights Reserved.