deploy()

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17package com.doc.samples;
18
19import java.io.*;
20
21import java.rmi.RemoteException;
22
23import com.sforce.soap.metadata.AsyncResult;
24import com.sforce.soap.metadata.DeployDetails;
25import com.sforce.soap.metadata.MetadataConnection;
26import com.sforce.soap.metadata.DeployOptions;
27import com.sforce.soap.metadata.DeployResult;
28import com.sforce.soap.metadata.DeployMessage;
29import com.sforce.soap.metadata.RunTestsResult;
30import com.sforce.soap.metadata.RunTestFailure;
31import com.sforce.soap.metadata.CodeCoverageWarning;
32import com.sforce.soap.enterprise.LoginResult;
33import com.sforce.soap.enterprise.EnterpriseConnection;
34import com.sforce.ws.ConnectionException;
35import com.sforce.ws.ConnectorConfig;
36
37/**
38 * Deploy a zip file of metadata components. 
39 * Prerequisite: Have a deploy.zip file that includes a package.xml manifest file that 
40 * details the contents of the zip file.
41 */
42public class DeploySample {
43    // binding for the metadata WSDL used for making metadata API calls
44    private MetadataConnection metadataConnection;
45
46    static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));
47
48    private static final String ZIP_FILE = "deploy.zip";
49
50    // one second in milliseconds
51    private static final long ONE_SECOND = 1000;
52    // maximum number of attempts to deploy the zip file
53    private static final int MAX_NUM_POLL_REQUESTS = 50; 
54
55    public static void main(String[] args) throws Exception {
56        final String USERNAME = "user@company.com";
57        // This is only a sample. Hard coding passwords in source files is a bad practice.
58        final String PASSWORD = "password"; 
59        final String URL = "https://login.salesforce.com/services/Soap/c/29.0";
60        
61        DeploySample sample = new DeploySample(USERNAME, PASSWORD, URL);
62        sample.deployZip();
63    }
64    
65    public DeploySample(String username, String password, String loginUrl) 
66            throws ConnectionException {
67        createMetadataConnection(username, password, loginUrl);
68    }
69
70    public void deployZip()
71        throws RemoteException, Exception
72    {
73        byte zipBytes[] = readZipFile();
74        DeployOptions deployOptions = new DeployOptions();
75        deployOptions.setPerformRetrieve(false);
76        deployOptions.setRollbackOnError(true);
77        AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);
78        String asyncResultId = asyncResult.getId();
79        
80        // Wait for the deploy to complete
81        int poll = 0;
82        long waitTimeMilliSecs = ONE_SECOND;
83        DeployResult deployResult = null;
84        boolean fetchDetails;
85        do {
86            Thread.sleep(waitTimeMilliSecs);
87            // double the wait time for the next iteration
88            waitTimeMilliSecs *= 2;
89            if (poll++ > MAX_NUM_POLL_REQUESTS) {
90                throw new Exception("Request timed out. If this is a large set " +
91                        "of metadata components, check that the time allowed by " +
92                        "MAX_NUM_POLL_REQUESTS is sufficient.");
93            }
94            
95            // Fetch in-progress details once for every 3 polls
96            fetchDetails = (poll % 3 == 0);
97            deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);
98            System.out.println("Status is: " + deployResult.getStatus());
99            if (!deployResult.isDone() && fetchDetails) {
100                printErrors(deployResult, "Failures for deployment in progress:\n");
101            }
102        }
103        while (!deployResult.isDone());
104        
105        if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {
106            throw new Exception(deployResult.getErrorStatusCode() + " msg: " +
107                    deployResult.getErrorMessage());
108        }
109
110        if (!fetchDetails) {
111            // Get the final result with details if we didn't do it in the last attempt.
112            deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);
113        }
114
115        if (!deployResult.isSuccess()) {
116            printErrors(deployResult, "Final list of failures:\n");
117            throw new Exception("The files were not successfully deployed");
118        }
119        
120        System.out.println("The file " + ZIP_FILE + " was successfully deployed");
121    }
122    
123    /**
124     * Read the zip file contents into a byte array.
125     * @return byte[]
126     * @throws Exception - if cannot find the zip file to deploy
127     */
128    private byte[] readZipFile()
129        throws Exception
130    {
131        // We assume here that you have a deploy.zip file.
132        // See the retrieve sample for how to retrieve a zip file.
133        File deployZip = new File(ZIP_FILE);
134        if (!deployZip.exists() || !deployZip.isFile())
135            throw new Exception("Cannot find the zip file to deploy. Looking for " +
136                    deployZip.getAbsolutePath());
137        
138        FileInputStream fos = new FileInputStream(deployZip);
139        ByteArrayOutputStream bos = new ByteArrayOutputStream();
140        int readbyte = -1;
141        while ((readbyte = fos.read()) != -1)  {
142            bos.write(readbyte);
143        }
144        fos.close();
145        bos.close();
146        return bos.toByteArray();
147    }
148    
149 
150    /**
151     * Print out any errors, if any, related to the deploy.
152     * @param result - DeployResult
153     */
154    private void printErrors(DeployResult result, String messageHeader)
155    {
156        DeployDetails deployDetails = result.getDetails();
157        
158        StringBuilder errorMessageBuilder = new StringBuilder();
159        if (deployDetails != null) {
160            DeployMessage[] componentFailures = deployDetails.getComponentFailures();
161            for (DeployMessage message : componentFailures) {
162                String loc = (message.getLineNumber() == 0 ? "" :
163                    ("(" + message.getLineNumber() + "," +
164                            message.getColumnNumber() + ")"));
165                if (loc.length() == 0
166                        && !message.getFileName().equals(message.getFullName())) {
167                    loc = "(" + message.getFullName() + ")";
168                }
169                errorMessageBuilder.append(message.getFileName() + loc + ":" +
170                        message.getProblem()).append('\n');
171            }
172            RunTestsResult rtr = deployDetails.getRunTestResult();
173            if (rtr.getFailures() != null) {
174                for (RunTestFailure failure : rtr.getFailures()) {
175                    String n = (failure.getNamespace() == null ? "" :
176                        (failure.getNamespace() + ".")) + failure.getName();
177                    errorMessageBuilder.append("Test failure, method: " + n + "." +
178                            failure.getMethodName() + " -- " +
179                            failure.getMessage() + " stack " +
180                            failure.getStackTrace() + "\n\n");
181                }
182            }
183            if (rtr.getCodeCoverageWarnings() != null) {
184                for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {
185                    errorMessageBuilder.append("Code coverage issue");
186                    if (ccw.getName() != null) {
187                        String n = (ccw.getNamespace() == null ? "" :
188                            (ccw.getNamespace() + ".")) + ccw.getName();
189                        errorMessageBuilder.append(", class: " + n);
190                    }
191                    errorMessageBuilder.append(" -- " + ccw.getMessage() + "\n");
192                }
193            }
194        }
195        
196        if (errorMessageBuilder.length() > 0) {
197            errorMessageBuilder.insert(0, messageHeader);
198            System.out.println(errorMessageBuilder.toString());
199        }
200    }
201    
202    private void createMetadataConnection( 
203        final String username,
204        final String password,
205        final String loginUrl) throws ConnectionException {
206
207        final ConnectorConfig loginConfig = new ConnectorConfig();
208        loginConfig.setAuthEndpoint(loginUrl);
209        loginConfig.setServiceEndpoint(loginUrl);
210        loginConfig.setManualLogin(true);
211        LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(
212                username, password);
213        
214        final ConnectorConfig metadataConfig = new ConnectorConfig();
215        metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());
216        metadataConfig.setSessionId(loginResult.getSessionId());
217        this.metadataConnection = new MetadataConnection(metadataConfig);
218    }
219
220}