A B C D E F G H I L M N O P R S T U V W

A

Aborted - interface com.sap.sdm.api.remote.deployresults.Aborted.

Represents the result type of an executed deployment process that was aborted.

AbstractParamContainer - interface com.sap.sdm.api.remote.AbstractParamContainer.

An abstract container for Param objects.

addParam(Param) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Adds a Param to this DynSizeParamContainer.

addTargetSystem(TargetSystem) - Method in interface com.sap.sdm.api.remote.TargetSystemContainer

Adds a TargetSystem to this TargetSystemContainer.

Admitted - interface com.sap.sdm.api.remote.deployresults.Admitted.

Represents the result type of a deployment process that was not executed yet.

AlreadyDeployed - interface com.sap.sdm.api.remote.deployresults.AlreadyDeployed.

Represents the result type of a not executed deployment process.

B

BOOLEAN - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the boolean type.

BOOLEAN_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the boolean type.

BYTE - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the byte type.

BYTE_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the byte type.

C

canAddParam(Param) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Indicates whether the specified Param can be added to this DynSizeParamContainer.

canAddTargetSystem(TargetSystem) - Method in interface com.sap.sdm.api.remote.TargetSystemContainer

Indicates whether the specified TargetSystem can be added to this TargetSystemContainer.

canRemoveParam(Param) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Indicates whether the specified Param can be removed from this DynSizeParamContainer.

canRemoveParamByName(String) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Indicates whether a Param with the specified name can be removed from this DynSizeParamContainer.

Client - interface com.sap.sdm.api.remote.Client.

An entry point to the functional methods provided by SDM for a remote client.

ClientLog - interface com.sap.sdm.api.remote.ClientLog.

Represents the part of the SDM log which belongs to this client.

ClientSession - interface com.sap.sdm.api.remote.ClientSession.

Represents a client session on an SDM server.

ClientSessionFactory - class com.sap.sdm.api.remote.ClientSessionFactory.

An entry point for a client of the SDM remote client API.

ClientSessionFactory() - Constructor for class com.sap.sdm.api.remote.ClientSessionFactory

closeSession() - Method in interface com.sap.sdm.api.remote.ClientSession

Closes this ClientSession.

com.sap.sdm.api.remote - package com.sap.sdm.api.remote

com.sap.sdm.api.remote.deployresults - package com.sap.sdm.api.remote.deployresults

ComponentVersionHandlingRule - interface com.sap.sdm.api.remote.ComponentVersionHandlingRule.

Represents a rule regarding handling of different versions of DCs which could be used for deployment.

ComponentVersionHandlingRules - interface com.sap.sdm.api.remote.ComponentVersionHandlingRules.

All possible int and String represantations for ComponentVersionHandlingRule.

createComponentVersionHandlingRule(int) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a ComponentVersionHandlingRule according to the specified int represantation of the rule.

createDeployItem(File) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a DeployItem for the specified archive.

createErrorHandlingRule(int) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a ErrorHandlingRule according to the specified int represantation of the rule.

createParam(ParamType, String, Object, boolean) - Method in interface com.sap.sdm.api.remote.HelperFactory

Deprecated.

createParam(ParamType, String, String, Object, boolean) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a Param object with the specified type, name, display name, value and "hidden" attribute.

createRemoteClientSession(int, String) - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Deprecated.

createRemoteClientSession(int, String, String) - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Creates a client session on the specified SDM server.

createRemoteClientSessionIDE(int, String, String) - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Creates a client session on the specified SDM server.

createTargetSystem(String, ServerType, String) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a TargetSystem object with the specified ID, type and an optional description.

createType(int) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a ParamType object with the specified type.

createUndeployItem(String, String) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a UnDeployItem.

createUndeployItem(String, String, String, String) - Method in interface com.sap.sdm.api.remote.HelperFactory

Creates a UnDeployItem.

D

deploy(DeployItem[]) - Method in interface com.sap.sdm.api.remote.DeployProcessor

Executes the deployment of the specified archives on the SDM server.

DeployItem - interface com.sap.sdm.api.remote.DeployItem.

Provides a link from an archive to its deploy result.

DeployProcessor - interface com.sap.sdm.api.remote.DeployProcessor.

Provides methods for executing the deployment process on the remote server.

DeployResult - interface com.sap.sdm.api.remote.DeployResult.

Represents the result of a started deployment process.

DeployResultType - interface com.sap.sdm.api.remote.deployresults.DeployResultType.

Represents the result type of a started deployment process.

DOUBLE - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the double type.

DOUBLE_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the double type.

DynSizeParamContainer - interface com.sap.sdm.api.remote.DynSizeParamContainer.

A container for a variable number of Param objects.

E

ErrorHandlingRule - interface com.sap.sdm.api.remote.ErrorHandlingRule.

Represents a rule regarding deploy-time error handling.

ErrorHandlingRules - interface com.sap.sdm.api.remote.ErrorHandlingRules.

This class is new with API client version 5.

Executed - interface com.sap.sdm.api.remote.deployresults.Executed.

Represents the result type of an executed deployment process.

F

FixedSizeParamContainer - interface com.sap.sdm.api.remote.FixedSizeParamContainer.

A container for a fixed number of Param objects.

FLOAT - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the float type.

FLOAT_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the float type.

G

getAPIClientVersion() - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Returns the version information for the SDMClient.jar in use.

getAPIServerVersion() - Method in interface com.sap.sdm.api.remote.Client

Returns the version information for the SDM Server this Client is connected to.

getAsStrings() - Method in interface com.sap.sdm.api.remote.ClientLog

Returns an array of Strings containing the part of the log text of the SDM log which belongs to this client.

getAsURL() - Method in interface com.sap.sdm.api.remote.ClientLog

Returns a URL identifying the part of the SDM log which belongs to this client.

getClient() - Method in interface com.sap.sdm.api.remote.ClientSession

Returns a Client object that provides the functional methods for a client.

getClientLog() - Method in interface com.sap.sdm.api.remote.Client

Deprecated.

getComponentVersionHandlingRule() - Method in interface com.sap.sdm.api.remote.DeployProcessor

Returns the rule which is used for the version handling by this DeployProcessor.

getConfiguration() - Method in interface com.sap.sdm.api.remote.TargetSystem

Returns the configuration of this TargetSystem.

getDeploymentID() - Method in interface com.sap.sdm.api.remote.UnDeployItem

Returns the deploymentID of the undeployed component after the undeployment has been executed.

getDeployProcessor() - Method in interface com.sap.sdm.api.remote.Client

Returns a DeployProcessor.

getDeployResult() - Method in interface com.sap.sdm.api.remote.DeployItem

Returns the deploy result of the linked archive after the deployment has been executed.

getDescription() - Method in interface com.sap.sdm.api.remote.ServerType

Returns a textual description of this ServerType.

getDescription() - Method in interface com.sap.sdm.api.remote.TargetSystem

Returns a textual description of this TargetSystem.

getDisplayName() - Method in interface com.sap.sdm.api.remote.Param

Returns the display name of the parameter.

getErrorHandlingRule() - Method in interface com.sap.sdm.api.remote.DeployProcessor

Returns the rule which is used for the error handling by this DeployProcessor.

getFile() - Method in interface com.sap.sdm.api.remote.URLMimic

Returns the file part of the represented URL.

getHelperFactory() - Method in interface com.sap.sdm.api.remote.Client

Returns a HelperFactory.

getHost() - Method in interface com.sap.sdm.api.remote.URLMimic

Returns the host part of the represented URL.

getID() - Method in interface com.sap.sdm.api.remote.TargetSystem

Returns the ID of this TargetSystem.

getLog() - Method in interface com.sap.sdm.api.remote.Client

Returns the ClientLog.

getLoginTimeout() - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Returns the timeout in ms which is used for the initial login to the SDM server.

getName() - Method in interface com.sap.sdm.api.remote.Param

Returns the name of the parameter.

getName() - Method in interface com.sap.sdm.api.remote.ServerType

Returns the name of this ServerType.

getParamByName(String) - Method in interface com.sap.sdm.api.remote.AbstractParamContainer

Returns the Param with the specified name, if it is contained in this AbstractParamContainer.

getParams() - Method in interface com.sap.sdm.api.remote.AbstractParamContainer

Returns all Param objects in this AbstractParamContainer.

getPort() - Method in interface com.sap.sdm.api.remote.URLMimic

Returns the port part of the represented URL.

getProtocol() - Method in interface com.sap.sdm.api.remote.URLMimic

Returns the protocol part of the represented URL.

getResultText() - Method in interface com.sap.sdm.api.remote.DeployResult

Returns the result text of the started deployment process.

getResultText() - Method in interface com.sap.sdm.api.remote.UnDeployResult

Returns the result text of the started undeployment process.

getRuleAsInt() - Method in interface com.sap.sdm.api.remote.ComponentVersionHandlingRule

Returns an int representation of this ComponentVersionHandlingRule.

getRuleAsInt() - Method in interface com.sap.sdm.api.remote.ErrorHandlingRule

Returns an int representation of this ErrorHandlingRule.

getRuleAsString() - Method in interface com.sap.sdm.api.remote.ComponentVersionHandlingRule

Returns a String representation of this ComponentVersionHandlingRule.

getRuleAsString() - Method in interface com.sap.sdm.api.remote.ErrorHandlingRule

Returns a String representation of this ErrorHandlingRule.

getRuleDescription() - Method in interface com.sap.sdm.api.remote.ComponentVersionHandlingRule

Returns a String containing a short description of this ComponentVersionHandlingRule.

getRuleDescription() - Method in interface com.sap.sdm.api.remote.ErrorHandlingRule

Returns a String containing a short description of this ErrorHandlingRule.

getSDMConfiguration() - Method in interface com.sap.sdm.api.remote.Client

Returns an SDMConfig.

getServerTypes() - Method in interface com.sap.sdm.api.remote.SDMConfig

Returns the supported server types.

getSubstVarContainer() - Method in interface com.sap.sdm.api.remote.SDMConfig

Returns the defined substitution variables.

getTargetSystemByID(String) - Method in interface com.sap.sdm.api.remote.TargetSystemContainer

Returns the TargetSystem with the specified ID.

getTargetSystemByServerType(ServerType) - Method in interface com.sap.sdm.api.remote.TargetSystemContainer

Returns the TargetSystem with the specified ServerType.

getTargetSystemContainer() - Method in interface com.sap.sdm.api.remote.SDMConfig

Returns the registered target systems.

getTargetSystems() - Method in interface com.sap.sdm.api.remote.TargetSystemContainer

Returns all target systems in this container.

getType() - Method in interface com.sap.sdm.api.remote.Param

Returns the type of the parameter.

getType() - Method in interface com.sap.sdm.api.remote.DeployResult

Returns the result type of the started deployment process.

getType() - Method in interface com.sap.sdm.api.remote.TargetSystem

Returns the server type of this TargetSystem.

getType() - Method in interface com.sap.sdm.api.remote.UnDeployResult

Returns the result type of the started undeployment process.

getTypeAsInt() - Method in interface com.sap.sdm.api.remote.ParamType

Returns an int representation of this ParamType.

getTypeAsString() - Method in interface com.sap.sdm.api.remote.ParamType

Returns a String representation of this ParamType.

getUnDeployProcessor() - Method in interface com.sap.sdm.api.remote.Client

Returns a UnDeployProcessor.

getUnDeployResult() - Method in interface com.sap.sdm.api.remote.UnDeployItem

Returns the undeploy result of the linked component after the undeployment has been executed.

getValueBoolean() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.BOOLEAN.

getValueByte() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.BYTE.

getValueDouble() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.DOUBLE.

getValueFloat() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.FLOAT.

getValueInt() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.INT.

getValueLong() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.LONG.

getValueObject() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of this Param as Object.

getValueShort() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.SHORT.

getValueString() - Method in interface com.sap.sdm.api.remote.Param

Returns the value of Param objects with type ParamTypes.STRING.

H

HelperFactory - interface com.sap.sdm.api.remote.HelperFactory.

Enables the client to create objects that are not provided by the SDM server.

I

Initial - interface com.sap.sdm.api.remote.deployresults.Initial.

Represents the result type of a deployment process that was not executed yet.

INT - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the int type.

INT_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the int type.

isConfigurationComplete() - Method in interface com.sap.sdm.api.remote.TargetSystem

Indicates whether the configuration of this TargetSystem is complete.

isValueSet() - Method in interface com.sap.sdm.api.remote.Param

Indicates whether this Param contains a value different from null.

L

LONG - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the long type.

LONG_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the long type.

M

MAX_TYPE - Static variable in interface com.sap.sdm.api.remote.ParamTypes

MAX_TYPE_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

N

NotExecuted - interface com.sap.sdm.api.remote.deployresults.NotExecuted.

Represents the result type of a not executed deployment process.

O

ON_ERROR_IGNORE - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Specifies that no matter whether a deployment error has occurred so far, the deployment iteration through the given set of deployments will be continued.

ON_ERROR_IGNORE_DESC - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Description of ON_ERROR_IGNORE_DESC

ON_ERROR_IGNORE_S - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

String representation of ON_ERROR_IGNORE

ON_ERROR_SKIP_DEPENDING - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Specifies that all deployments that depend on deployments having been executed not successfully will not be executed but have to be skipped instead.

ON_ERROR_SKIP_DEPENDING_DESC - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Description of ON_ERROR_SKIP_DEPENDING

ON_ERROR_SKIP_DEPENDING_S - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

String representation of ON_ERROR_SKIP_DEPENDING

ON_ERROR_STOP - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Specifies that once a deployment error occurs, the further processing will be stopped.

ON_ERROR_STOP_DESC - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

Description of ON_ERROR_STOP

ON_ERROR_STOP_S - Static variable in interface com.sap.sdm.api.remote.ErrorHandlingRules

String representation of ON_ERROR_STOP

P

Param - interface com.sap.sdm.api.remote.Param.

Represents a parameter.

ParamType - interface com.sap.sdm.api.remote.ParamType.

Represents a parameter type.

ParamTypes - interface com.sap.sdm.api.remote.ParamTypes.

Summarizes the permitted types of Param objects.

passivateSession() - Method in interface com.sap.sdm.api.remote.ClientSession

Passivates this ClientSession.

PreconditionViolated - interface com.sap.sdm.api.remote.deployresults.PreconditionViolated.

Represents the result type of a not executed deployment process.

R

Rejected - interface com.sap.sdm.api.remote.deployresults.Rejected.

Represents the result type of a not executed deployment process.

RemoteException - exception com.sap.sdm.api.remote.RemoteException.

Signals that the communication between client and server has failed or has been interrupted.

RemoteException(String) - Constructor for class com.sap.sdm.api.remote.RemoteException

removeParam(Param) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Removes the specified Param from this DynSizeParamContainer.

removeParamByName(String) - Method in interface com.sap.sdm.api.remote.DynSizeParamContainer

Removes a Param with the specified name from this DynSizeParamContainer.

S

save() - Method in interface com.sap.sdm.api.remote.AbstractParamContainer

Saves the container and its contents to the persistent SDM repository.

SDMConfig - interface com.sap.sdm.api.remote.SDMConfig.

Represents the configuration of the SDM server.

ServerType - interface com.sap.sdm.api.remote.ServerType.

Represents a server type.

setComponentVersionHandlingRule(ComponentVersionHandlingRule) - Method in interface com.sap.sdm.api.remote.DeployProcessor

Sets the rule which should be used for the version handling by this DeployProcessor.

setErrorHandlingRule(ErrorHandlingRule) - Method in interface com.sap.sdm.api.remote.DeployProcessor

Sets the rule which should be used for the error handling by this DeployProcessor.

setLoginTimeout(int) - Static method in class com.sap.sdm.api.remote.ClientSessionFactory

Sets the timeout in ms which is used for the initial login to the SDM server.

setValue(Object) - Method in interface com.sap.sdm.api.remote.Param

Sets the value of this Param as an Object.

SHORT - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the short type.

SHORT_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the short type.

Skipped - interface com.sap.sdm.api.remote.deployresults.Skipped.

Represents the result type of a skipped deployment process.

STRING - Static variable in interface com.sap.sdm.api.remote.ParamTypes

An int representation of the String type.

STRING_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

A String representation of the String type.

Success - interface com.sap.sdm.api.remote.deployresults.Success.

Represents the result type of an executed deployment process that was successful.

T

TargetSystem - interface com.sap.sdm.api.remote.TargetSystem.

Represents a target system.

TargetSystemContainer - interface com.sap.sdm.api.remote.TargetSystemContainer.

A container for target systems.

U

undeploy(UnDeployItem[]) - Method in interface com.sap.sdm.api.remote.UnDeployProcessor

Executes the undeployment of the specified components on the SDM server.

UnDeployItem - interface com.sap.sdm.api.remote.UnDeployItem.

Provides a link from an archive to its deploy result.

UnDeployProcessor - interface com.sap.sdm.api.remote.UnDeployProcessor.

Provides methods for executing the undeployment process on the remote server.

UnDeployResult - interface com.sap.sdm.api.remote.UnDeployResult.

Represents the result of a started undeployment process.

UNKNOWN - Static variable in interface com.sap.sdm.api.remote.ParamTypes

UNKNOWN_S - Static variable in interface com.sap.sdm.api.remote.ParamTypes

UPDATE_ALL_VERSIONS - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

An int representation of the ComponentVersionHandlingRule UPDATE_ALL_VERSIONS.

UPDATE_ALL_VERSIONS_S - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

An int representation of the ComponentVersionHandlingRule UPDATE_ALL_VERSIONS.

UPDATE_LOWER_VERSIONS_ONLY - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

An int representation of the ComponentVersionHandlingRule UPDATE_LOWER_VERSIONS_ONLY.

UPDATE_LOWER_VERSIONS_ONLY_S - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

A String representation of the ComponentVersionHandlingRule UPDATE_LOWER_VERSIONS_ONLY.

UPDATE_SAME_AND_LOWER_VERSIONS_ONLY - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

An int representation of the ComponentVersionHandlingRule UPDATE_SAME_AND_LOWER_VERSIONS_ONLY.

UPDATE_SAME_AND_LOWER_VERSIONS_ONLY_S - Static variable in interface com.sap.sdm.api.remote.ComponentVersionHandlingRules

An int representation of the ComponentVersionHandlingRule UPDATE_SAME_AND_LOWER_VERSIONS_ONLY.

URLMimic - interface com.sap.sdm.api.remote.URLMimic.

Represents a Uniform Resource Locator, mimicking the java.net.URL class.

V

valueShallBeHidden() - Method in interface com.sap.sdm.api.remote.Param

Indicates whether to represent the value of this Param in clear text or not when exporting this Param to some external interface.

W

Warning - interface com.sap.sdm.api.remote.deployresults.Warning.

Represents the result type of an executed deployment process that was finished with warning(s).

WrongPasswordException - exception com.sap.sdm.api.remote.WrongPasswordException.

Signals that the wrong password was used for login trial.

WrongPasswordException(String) - Constructor for class com.sap.sdm.api.remote.WrongPasswordException

A B C D E F G H I L M N O P R S T U V W