DiagnosticAgent


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  package com.sun.enterprise.diagnostics;
24  
25  import java.util.zip.ZipFile  ;
26  import java.util.List  ;
27  import java.util.Map  ;
28  
29  /**
30   *
31   * @author Manisha Umbarje
32   */
33  public interface DiagnosticAgent {
34      /**
35       * Generates Diagnostic Report
36       * @param clioptions cli options specified by the user
37       * @return zip containing diagnostic report
38       * @throw DiagnosticException 
39       */
40      public String   generateReport(Map   clioptions) throws DiagnosticException ;
41      
42      /**
43       * Generates Diagnostic Report
44       * @param clioptions cli options specified by the user
45       * @instances list of instance names for which report generation is invoked
46       * @targetType type of the target for which report is being generated
47       * @return zip containing diagnostic report
48       * @throw DiagnosticException 
49       */
50      public String   generateReport(Map   clioptions, List  <String  > instances,
51              String   targetType) throws DiagnosticException ;
52      
53      /**
54       * @param repositoryDir absolute path of central repository
55       * @return list of attributes being masked with ****
56       * @throw DiagnosticException 
57       */
58      public List  <String  > getConfidentialProperties(String   repositoryDir) 
59      throws DiagnosticException;
60      
61      
62      /**
63       * Deletes report specified by the file
64       * @param file File to be deleted.
65       * @throws DiagnosticException
66       */
67      public void deleteReport(String   file) throws DiagnosticException;
68                    
69  }
70
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags