01: /*
02: * BEGIN_HEADER - DO NOT EDIT
03: *
04: * The contents of this file are subject to the terms
05: * of the Common Development and Distribution License
06: * (the "License"). You may not use this file except
07: * in compliance with the License.
08: *
09: * You can obtain a copy of the license at
10: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
11: * See the License for the specific language governing
12: * permissions and limitations under the License.
13: *
14: * When distributing Covered Code, include this CDDL
15: * HEADER in each file and include the License file at
16: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
17: * If applicable add the following below this CDDL HEADER,
18: * with the fields enclosed by brackets "[]" replaced with
19: * your own identifying information: Portions Copyright
20: * [year] [name of copyright owner]
21: */
22:
23: /*
24: * @(#)ServiceUnitInfo.java
25: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
26: *
27: * END_HEADER - DO NOT EDIT
28: */
29: package com.sun.jbi;
30:
31: /**
32: * This interface provides information on Service Units.
33: * @author Sun Microsystems, Inc.
34: */
35: public interface ServiceUnitInfo {
36:
37: /**
38: * Determine if the supplied Object is equal to this one.
39: * @param object - the Object to be compared with this one.
40: * @return true if the supplied Object is equal to this one.
41: */
42: boolean equals(Object object);
43:
44: /**
45: * Get the name of the Service Unit.
46: * @return the name of the Service Unit.
47: */
48: String getName();
49:
50: /**
51: * Get the name of the Service Assembly containing this Service Unit.
52: * @return the name of the Service Assembly.
53: */
54: String getServiceAssemblyName();
55:
56: /**
57: * Get the state of the Service Unit.
58: * @return current state
59: */
60: ServiceUnitState getState();
61:
62: /**
63: * Get the state of the Service Unit as a string.
64: * @return current state, as one of the values: "shutdown", "stopped",
65: * "started".
66: */
67: String getStateAsString();
68:
69: /**
70: * Get the Service Units target component
71: *
72: * @return the target component name
73: */
74: String getTargetComponent();
75:
76: /**
77: * Get the path to the Service Unit archive.
78: * @return the file path.
79: */
80: public String getFilePath();
81: }
|