deploy()

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