com.sap.sdm.api.remote
Interface DeployProcessor

public interface DeployProcessor

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

Version:

1.0

Method Summary

void	deploy(DeployItem[] deployItems) Executes the deployment of the specified archives on the SDM server.
ComponentVersionHandlingRule	getComponentVersionHandlingRule() Returns the rule which is used for the version handling by this DeployProcessor.
ErrorHandlingRule	getErrorHandlingRule() Returns the rule which is used for the error handling by this DeployProcessor.
void	setComponentVersionHandlingRule(ComponentVersionHandlingRule rule) Sets the rule which should be used for the version handling by this DeployProcessor.
void	setErrorHandlingRule(ErrorHandlingRule rule) Sets the rule which should be used for the error handling by this DeployProcessor.

Method Detail

deploy

public void deploy(DeployItem[] deployItems)
            throws RemoteException

Executes the deployment of the specified archives on the SDM server. Each archive is specified via a DeployItem that also provides a description of the deploy result for the particular archive after the method has returned. Regarding the handling of different versions for a DC during deployment an explicit ComponentVersionHandlingRule can be set. If no explicit rule was set the default is ComponentVersionHandlingRules.UPDATE_ALL_VERSIONS

Parameters:

deployItems - an array of DeployItem

Returns:

a URLMimic pointing to a file that contains the logs of the executed deploy process

getComponentVersionHandlingRule

public ComponentVersionHandlingRule getComponentVersionHandlingRule()
                                                             throws RemoteException

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

Returns:

a ComponentVersionHandlingRule describing the rule for version handling of this DeployProcessor

setComponentVersionHandlingRule

public void setComponentVersionHandlingRule(ComponentVersionHandlingRule rule)
                                     throws RemoteException

Sets the rule which should be used for the version handling by this DeployProcessor. The rule will be applied by all following calls of the deploy method.

Parameters:

rule - a ComponentVersionHandlingRule specifying the rule to be applied

Throws:

NullPointerException - if rule is null

See Also:

HelperFactory.createComponentVersionHandlingRule(int)

getErrorHandlingRule

public ErrorHandlingRule getErrorHandlingRule()
                                       throws RemoteException

Returns the rule which is used for the error handling by this DeployProcessor. This method is new with API client version 5.

Returns:

a ErrorHandlingRule describing the rule for version handling of this DeployProcessor

setErrorHandlingRule

public void setErrorHandlingRule(ErrorHandlingRule rule)
                          throws RemoteException

Sets the rule which should be used for the error handling by this DeployProcessor. The rule will be applied by all following calls of the deploy method. This method is new with API client version 5.

Parameters:

rule - a ErrorHandlingRule specifying the rule to be applied

Throws:

NullPointerException - if rule is null

See Also:

com.sap.sdm.api.local.HelperFactory#createErrorHandlingRule(int)