Source code: com/flexstor/ejb/util/Ping.java
1 /*
2 * Ping.java
3 *
4 * Copyright $Date: 2003/08/11 02:22:35 $ FLEXSTOR.net Inc.
5 *
6 * This work is licensed for use and distribution under license terms found at
7 * http://www.flexstor.org/license.html
8 *
9 */
10
11 package com.flexstor.ejb.util;
12
13 import java.rmi.RemoteException;
14
15 import com.flexstor.common.data.ejb.util.PingData;
16
17 /**
18 *
19 * <P>
20 * Ping <BR>
21 * <BLOCKQUOTE>
22 * This interface allows the client to determine if the EJB Server is up and ready for processing. <BR>
23 * Once confirmed that in fact that the EJB Server is up and running, it provides information about <BR>
24 * the enviroment it is running in such as version and database server. <BR>
25 * </BLOCKQUOTE>
26 * </P>
27 *
28 * <P>
29 * Uses cache: no
30 *
31 * State Management Type: Stateless
32 * </P>
33 *
34 * Configurable properties in flexdm.properties: <BR>
35 * <BLOCKQUOTE>
36 * <P>
37 * DBVendor: Name of database Vendor; to be displayed by client <BR>
38 * Legal values: A String <BR>
39 * </P>
40 * <P>
41 * DBName: Name of the database instance; to be displayed by the client <BR>
42 * Legal values: A Strin of the form {DB Server}:{DB Port}:{DB Instance Name} <BR>
43 * </P>
44 * <P>
45 * DBVersion: The version of the database; to be displayed by the client <BR>
46 * Legal values: A String <BR>
47 * </P>
48 * </BLOCKQUOTE>
49 *
50 */
51 public interface Ping extends com.flexstor.ejb.EjbObject {
52 // MKS macro expander
53 public final static String IDENTIFIER = "$Id: Ping.java,v 1.3 2003/08/11 02:22:35 aleric Exp $";
54
55 /**
56 * Determine whether the EJB Server is up and in addition, inform the client what versions of software
57 * is currently running on the server.
58 * Transaction Attribute: Not Supported
59 *
60 * @return - version information wrapped in a PingData object
61 *
62 * @exception java.rmi.RemoteException - trouble with the EJB Server
63 */
64 public PingData ping()
65 throws RemoteException;
66 }