|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SchedulerMBean
MBean interface.
Field Summary | |
---|---|
static javax.management.ObjectName |
OBJECT_NAME
|
Fields inherited from interface org.jboss.system.ServiceMBean |
---|
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED |
Method Summary | |
---|---|
String |
getDateFormat()
|
long |
getInitialRepetitions()
|
String |
getInitialStartDate()
|
long |
getRemainingRepetitions()
|
String |
getSchedulableArguments()
|
String |
getSchedulableArgumentTypes()
|
String |
getSchedulableClass()
|
String |
getSchedulableMBean()
|
long |
getSchedulePeriod()
|
String |
getTimerName()
|
boolean |
isActive()
|
boolean |
isRestartPending()
|
boolean |
isStartAtStartup()
|
boolean |
isStarted()
|
boolean |
isUsingMBean()
|
void |
restartSchedule()
Stops the server right now and starts it right now. |
void |
setDateFormat(String dateFormat)
Sets the date format used to parse date/times |
void |
setInitialRepetitions(long pNumberOfCalls)
Sets the initial number of scheduled calls. |
void |
setInitialStartDate(String pStartDate)
Sets the first scheduled call. |
void |
setSchedulableArguments(String pArgumentList)
|
void |
setSchedulableArgumentTypes(String pTypeList)
Sets the comma seperated list of argument types for the Schedulable class. |
void |
setSchedulableClass(String pSchedulableClass)
Sets the fully qualified Class name of the Schedulable Class being called by the Scheduler. |
void |
setSchedulableMBean(String pSchedulableMBean)
Sets the fully qualified JMX MBean name of the Schedulable MBean to be called. |
void |
setSchedulableMBeanMethod(String pSchedulableMBeanMethod)
Sets the method name to be called on the Schedulable MBean. |
void |
setSchedulePeriod(long pPeriod)
Sets the Schedule Period between two scheduled call. |
void |
setStartAtStartup(boolean pStartAtStartup)
Set the scheduler to start when MBean started or not. |
void |
setTimerName(String pTimerName)
|
void |
startSchedule()
Starts the schedule if the schedule is stopped otherwise nothing will happen. |
void |
stopSchedule(boolean pDoItNow)
Stops the schedule because it is either not used anymore or to restart it with new values. |
Methods inherited from interface org.jboss.system.ServiceMBean |
---|
getName, getState, getStateString, jbossInternalLifecycle |
Methods inherited from interface org.jboss.system.Service |
---|
create, destroy, start, stop |
Field Detail |
---|
static final javax.management.ObjectName OBJECT_NAME
Method Detail |
---|
void startSchedule()
InvalidParameterException
- If any of the necessary values are not set or invalid (especially for the Schedulable class attributes).void stopSchedule(boolean pDoItNow)
pDoItNow
- If true the schedule will be stopped without waiting for the next scheduled call otherwise the next call will be performed before the schedule is stopped.void restartSchedule()
String getSchedulableClass()
void setSchedulableClass(String pSchedulableClass) throws InvalidParameterException
setSchedulableArguments(java.lang.String)
and setSchedulableArgumentTypes(java.lang.String)
.
pSchedulableClass
- Fully Qualified Schedulable Class.
InvalidParameterException
- If the given value is not a valid class or cannot be loaded by the Scheduler or is not of instance Schedulable.String getSchedulableArguments()
void setSchedulableArguments(String pArgumentList)
String getSchedulableArgumentTypes()
void setSchedulableArgumentTypes(String pTypeList) throws InvalidParameterException
pTypeList
- List of arguments used to create the Schedulable intance. If the list is null or empty then the no-args constructor is used.
InvalidParameterException
- If the given list contains a unknow datat type.String getSchedulableMBean()
void setSchedulableMBean(String pSchedulableMBean) throws InvalidParameterException
setSchedulableClass(java.lang.String)
, setSchedulableArguments(java.lang.String)
and setSchedulableArgumentTypes(java.lang.String)
are cleared and not used anymore. Therefore only use either Schedulable Class or Schedulable MBean. If setSchedulableMBeanMethod(java.lang.String)
is not set then the schedule method as in the Schedulable.perform(java.util.Date, long)
will be called with the same arguments. Also note that the Object Name will not be checked if the MBean is available. If the MBean is not available it will not be called but the remaining repetitions will be decreased.
pSchedulableMBean
- JMX MBean Object Name which should be called.
InvalidParameterException
- If the given value is an valid Object Name.void setSchedulableMBeanMethod(String pSchedulableMBeanMethod) throws InvalidParameterException
pSchedulableMBeanMethod
- Name of the method to be called optional followed by method arguments (see above).
InvalidParameterException
- If the given value is not of the right formatboolean isUsingMBean()
long getSchedulePeriod()
void setSchedulePeriod(long pPeriod)
pPeriod
- Time between to scheduled calls (after the initial call) in Milliseconds. This value must be bigger than 0.
InvalidParameterException
- If the given value is less or equal than 0String getDateFormat()
void setDateFormat(String dateFormat)
dateFormat
- The date format when empty or null the locale is used to parse datesString getInitialStartDate()
void setInitialStartDate(String pStartDate)
pStartDate
- Date when the initial call is scheduled. It can be either: long getInitialRepetitions()
void setInitialRepetitions(long pNumberOfCalls)
pNumberOfCalls
- Initial Number of scheduled calls. If -1 then the number is unlimted.
InvalidParameterException
- If the given value is less or equal than 0long getRemainingRepetitions()
boolean isStarted()
boolean isRestartPending()
boolean isStartAtStartup()
void setStartAtStartup(boolean pStartAtStartup)
startService()
gets called (normally at startup time.
pStartAtStartup
- True if Schedule has to be started at startup timeboolean isActive()
String getTimerName()
void setTimerName(String pTimerName)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |