railo.runtime.tag
Class Schedule

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.tag.Schedule
All Implemented Interfaces:
javax.servlet.jsp.tagext.Tag

public final class Schedule
extends TagImpl

Provides a programmatic interface to the Railo scheduling engine. You can run a specified page at scheduled intervals with the option to write out static HTML pages. This lets you offer users access to pages that publish data, such as reports, without forcing users to wait while a database transaction is performed in order to populate the data on the page.


Field Summary
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Schedule()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setAction(String action)
          set the value action
 void setAutodelete(boolean autoDelete)
           
 void setEnddate(Object enddate)
          set the value enddate The date when the scheduled task ends.
 void setEndtime(Object endtime)
          set the value endtime The time when the scheduled task ends.
 void setFile(String file)
          set the value file Required with publish ='Yes' A valid filename for the published file.
 void setHidden(boolean hidden)
           
 void setInterval(String interval)
          set the value interval Required when creating tasks with action = 'update'.
 void setOperation(String operation)
          set the value operation The type of operation the scheduler performs when executing this task.
 void setPassword(String password)
          set the value password Password if URL is protected.
 void setPath(String path)
          set the value path Required with publish ='Yes' The path location for the published file.
 void setPaused(boolean paused)
           
 void setPort(Object oPort)
          set the value port The port number on the server from which the task is being scheduled.
 void setProxypassword(String proxypassword)
           
 void setProxyport(Object oProxyport)
          set the value proxyport The port number on the proxy server from which the task is being requested.
 void setProxyserver(String proxyserver)
          set the value proxyserver Host name or IP address of a proxy server.
 void setProxyuser(String proxyuser)
           
 void setPublish(boolean publish)
          set the value publish Specifies whether the result should be saved to a file.
 void setReadonly(boolean readonly)
           
 void setRequesttimeout(Object oRequesttimeout)
          set the value requesttimeout Customizes the requestTimeOut for the task operation.
 void setResolveurl(boolean resolveurl)
          set the value resolveurl Specifies whether to resolve links in the result page to absolute references.
 void setReturnvariable(String returnvariable)
           
 void setServerpassword(String serverPassword)
           
 void setStartdate(Object objStartDate)
          set the value startdate Required when action ='update'.
 void setStarttime(Object starttime)
          set the value starttime Required when creating tasks with action = 'update'.
 void setTask(String task)
          set the value task The name of the task to delete, update, or run.
 void setUrl(String url)
          set the value url Required when action = 'update'.
 void setUsername(String username)
          set the value username Username if URL is protected.
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Schedule

public Schedule()
Method Detail

setAutodelete

public void setAutodelete(boolean autoDelete)

setReadonly

public void setReadonly(boolean readonly)
Parameters:
readonly - the readonly to set

setHidden

public void setHidden(boolean hidden)
Parameters:
hidden - the hidden to set

setReturnvariable

public void setReturnvariable(String returnvariable)
Parameters:
returnvariable - The returnvariable to set.

setProxypassword

public void setProxypassword(String proxypassword)
Parameters:
proxypassword - The proxypassword to set.

setProxyuser

public void setProxyuser(String proxyuser)
Parameters:
proxyuser - The proxyuser to set.

setPaused

public void setPaused(boolean paused)

setPassword

public void setPassword(String password)
set the value password Password if URL is protected.

Parameters:
password - value to set

setStartdate

public void setStartdate(Object objStartDate)
                  throws PageException
set the value startdate Required when action ='update'. The date when scheduling of the task should start.

Parameters:
objStartDate - value to set
Throws:
PageException

setResolveurl

public void setResolveurl(boolean resolveurl)
set the value resolveurl Specifies whether to resolve links in the result page to absolute references.

Parameters:
resolveurl - value to set

setServerpassword

public void setServerpassword(String serverPassword)

setAction

public void setAction(String action)
               throws ApplicationException
set the value action

Parameters:
action - value to set
Throws:
ApplicationException

setProxyserver

public void setProxyserver(String proxyserver)
set the value proxyserver Host name or IP address of a proxy server.

Parameters:
proxyserver - value to set

setEnddate

public void setEnddate(Object enddate)
                throws PageException
set the value enddate The date when the scheduled task ends.

Parameters:
enddate - value to set
Throws:
PageException

setFile

public void setFile(String file)
set the value file Required with publish ='Yes' A valid filename for the published file.

Parameters:
file - value to set

setStarttime

public void setStarttime(Object starttime)
                  throws PageException
set the value starttime Required when creating tasks with action = 'update'. Enter a value in seconds. The time when scheduling of the task starts.

Parameters:
starttime - value to set
Throws:
PageException

setProxyport

public void setProxyport(Object oProxyport)
                  throws PageException
set the value proxyport The port number on the proxy server from which the task is being requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.

Parameters:
proxyport - value to set
Throws:
PageException

setPort

public void setPort(Object oPort)
             throws PageException
set the value port The port number on the server from which the task is being scheduled. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.

Parameters:
port - value to set
Throws:
PageException

setEndtime

public void setEndtime(Object endtime)
                throws PageException
set the value endtime The time when the scheduled task ends. Enter a value in seconds.

Parameters:
endtime - value to set
Throws:
PageException

setOperation

public void setOperation(String operation)
                  throws ApplicationException
set the value operation The type of operation the scheduler performs when executing this task.

Parameters:
operation - value to set
Throws:
ApplicationException

setInterval

public void setInterval(String interval)
set the value interval Required when creating tasks with action = 'update'. Interval at which task should be scheduled. Can be set in seconds or as Once, Daily, Weekly, and Monthly. The default interval is one hour. The minimum interval is one minute.

Parameters:
interval - value to set

setPublish

public void setPublish(boolean publish)
set the value publish Specifies whether the result should be saved to a file.

Parameters:
publish - value to set

setRequesttimeout

public void setRequesttimeout(Object oRequesttimeout)
                       throws PageException
set the value requesttimeout Customizes the requestTimeOut for the task operation. Can be used to extend the default timeout for operations that require more time to execute.

Parameters:
requesttimeout - value to set
Throws:
PageException

setUsername

public void setUsername(String username)
set the value username Username if URL is protected.

Parameters:
username - value to set

setUrl

public void setUrl(String url)
set the value url Required when action = 'update'. The URL to be executed.

Parameters:
url - value to set

setPath

public void setPath(String path)
set the value path Required with publish ='Yes' The path location for the published file.

Parameters:
path - value to set

setTask

public void setTask(String task)
set the value task The name of the task to delete, update, or run.

Parameters:
task - value to set

doStartTag

public int doStartTag()
               throws PageException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
ApplicationException
PageException
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class TagImpl
See Also:
Tag.doEndTag()

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class TagImpl
See Also:
Tag.release()


Copyright © 2012 Railo