1 /*
2 * JBoss, Home of Professional Open Source.
3 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
4 * as indicated by the @author tags. See the copyright.txt file in the
5 * distribution for a full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.ha.singleton;
23
24 import javax.management.ObjectName;
25
26 /**
27 * The management interface for the singleton controller service.
28 *
29 * @see org.jboss.ha.framework.interfaces.HASingletonMBean
30 *
31 * @author <a href="mailto:ivelin@apache.org">Ivelin Ivanov</a>
32 * @author <a href="mailto:scott.stark@jboss.org">Scott Stark</a>
33 * @author <a href="mailto:mr@gedoplan.de">Marcus Redeker</a>
34 * @author <a href="mailto:dimitris@jboss.org">Dimitris Andreadis</a>
35 * @version $Revision: 81001 $
36 */
37 public interface HASingletonControllerMBean extends HASingletonSupportMBean
38 {
39 /**
40 * Sets the controlled target singleton
41 */
42 void setTarget(Object target);
43
44 /**
45 * Gets controlled target singleton
46 *
47 * @return the singleton, or <code>null</code> if this object is
48 * configured to use a
49 * {@link #setTargetName(ObjectName) JMX object name}.
50 */
51 Object getTarget();
52
53 /**
54 * Gets the ObjectName of the controlled target Singleton MBean
55 *
56 * @return the target object name, or <code>null</code> if this object is
57 * configured via {@link #setTarget(Object)}.
58 *
59 * @deprecated use {@link #getTarget()}
60 */
61 ObjectName getTargetName();
62 /**
63 * Sets the ObjectName of the controlled target Singleton MBean
64 *
65 * @param targetObjectName target of the MBean singleton
66 *
67 * @deprecated use {@link #setTarget(Object)}
68 */
69 void setTargetName(ObjectName targetObjectName);
70
71 /** The target method to call when the Singleton is started */
72 String getTargetStartMethod();
73 void setTargetStartMethod(String targetStartMethod);
74
75 /** The argument to pass to the start method of the singleton MBean */
76 String getTargetStartMethodArgument();
77 void setTargetStartMethodArgument(String targetStartMethodArgument);
78
79 /** The target method to call when the Singleton is stopped */
80 String getTargetStopMethod();
81 void setTargetStopMethod(String targetStopMethod);
82
83 /** The argument to pass to the stop method of the singleton MBean */
84 String getTargetStopMethodArgument();
85 void setTargetStopMethodArgument(String targetStopMethodArgument);
86 }
Save This Page