org.sandev.sandbuild
Class SandUIDeployment

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.sandev.sandbuild.SandTask
              org.sandev.sandbuild.SandUIDeployment

public class SandUIDeployment
extends SandTask

A SandUI declaration provides enough information for the build to create the necessary deployment linkage for a SandUI.

Notes on usage:

• The serialized SandUI definition file is found based on the name of the project + "SandUI.xml". So for example we might look for "TaskHeapDemoSandUI.xml" as a SandUI definition.
• The necessary source for the SandUI is created following the standard directory conventions. So for example the source for a webapp SandUI gets placed in the webapp directory for the project.

Field Summary

protected java.lang.String	fixedMode Flag to override the UI switching to secure communications as required for login, secured screens or by the application.
protected java.lang.String	forgotPasswordPrimary If forgotPassword is true, then the user has the option to enter just their username to be passed into the app for processing.
protected java.lang.String	forgotPasswordSecondary If forgotPassword is true, then the user will be prompted for their username.
protected java.lang.String	implClass The fully qualified name of the class implementing the interface specified by the type.
protected java.lang.String	maxInactiveMinutes The maximum time in minutes that a user may be inactive before their user session expires.
protected java.lang.String	name The name identifies this SandUI deployment.
protected java.lang.String	ownerNodeNameLookup The fully qualified name of the OwnerNodeNameLookup class.
protected boolean	rememberMe If rememberMe is true, the user has the option to record their login information on their computer so they don't need to enter the login information again.
protected java.lang.String	rememberMePassphrase If rememberMe is true, then a passphrase for encrypting the saved login information is required.
protected java.lang.String	type The type of SandUI to be created.

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

SandUIDeployment()

Method Summary

void	execute() Add ourselves to our project so the generators have access to this information.
java.lang.String	getFixedMode() accessor for fixedMode
java.lang.String	getForgotPasswordPrimary()
java.lang.String	getForgotPasswordSecondary()
java.lang.String	getImplClass()
java.lang.String	getMaxInactiveMinutes()
java.lang.String	getName()
java.lang.String	getOwnerNodeNameLookup()
boolean	getRememberMe()
java.lang.String	getRememberMePassphrase()
java.lang.String	getType()
void	setFixedMode(java.lang.String fixedMode) mutator for fixedMode
void	setForgotPasswordPrimary(java.lang.String val)
void	setForgotPasswordSecondary(java.lang.String val)
void	setImplClass(java.lang.String val)
void	setMaxInactiveMinutes(java.lang.String val)
void	setName(java.lang.String val)
void	setOwnerNodeNameLookup(java.lang.String val)
void	setRememberMe(boolean val)
void	setRememberMePassphrase(java.lang.String val)
void	setType(java.lang.String val)

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected java.lang.String name

The name identifies this SandUI deployment. For a webapp, the name is used as both the URL pattern and the shell servlet name.

type

protected java.lang.String type

The type of SandUI to be created. This defaults to "webapp". Possible values:

• "webapp" creates a standard XHTML web UI
• "fastXMLWS" creates a fast XML WebServices interface

implClass

protected java.lang.String implClass

The fully qualified name of the class implementing the interface specified by the type. Interfaces by type:

• webapp: Class implementing the SandUIAdaptor interface. For example org.sandev.tools.UIProcessor.XHTMLSandUIServlet
• fastXMLWS: Class implementing the RequestAdaptor interface. For example org.sandev.tools.UIProcessor.FastXMLWSServlet

ownerNodeNameLookup

protected java.lang.String ownerNodeNameLookup

The fully qualified name of the OwnerNodeNameLookup class. This is the class which will be called to return the name of the node that will be used for support processing. See the OwnerNodeNameLookup for details.

fixedMode

protected java.lang.String fixedMode

Flag to override the UI switching to secure communications as required for login, secured screens or by the application. If set to "true" then the UI will not switch modes. If set to "localhost" then UI will not switch modes if the server is localhost. The default is "false" indicating that the UI should switch to secure comms as needed.

rememberMe

protected boolean rememberMe

If rememberMe is true, the user has the option to record their login information on their computer so they don't need to enter the login information again. This is not as secure as requiring a password so by default this is false.

rememberMePassphrase

protected java.lang.String rememberMePassphrase

If rememberMe is true, then a passphrase for encrypting the saved login information is required. This passphrase is used to decrypt the saved password for automatic login.

forgotPasswordPrimary

protected java.lang.String forgotPasswordPrimary

If forgotPassword is true, then the user has the option to enter just their username to be passed into the app for processing. The app can then email their password to the address associated with this username, or send a notice to tech support, or whatever.

forgotPasswordSecondary

protected java.lang.String forgotPasswordSecondary

If forgotPassword is true, then the user will be prompted for their username. If this string is specified, then the user will also be prompted (using the value set here) to enter a secondary value for additional security testing or alternate lookup.

maxInactiveMinutes

protected java.lang.String maxInactiveMinutes

The maximum time in minutes that a user may be inactive before their user session expires. If not set, then the default value for the environment is used.

Constructor Detail

SandUIDeployment

public SandUIDeployment()

Method Detail

setName

public void setName(java.lang.String val)

getName

public java.lang.String getName()

setType

public void setType(java.lang.String val)

getType

public java.lang.String getType()

setImplClass

public void setImplClass(java.lang.String val)

getImplClass

public java.lang.String getImplClass()

setOwnerNodeNameLookup

public void setOwnerNodeNameLookup(java.lang.String val)

getOwnerNodeNameLookup

public java.lang.String getOwnerNodeNameLookup()

getFixedMode

public java.lang.String getFixedMode()

accessor for fixedMode

setFixedMode

public void setFixedMode(java.lang.String fixedMode)

mutator for fixedMode

setRememberMe

public void setRememberMe(boolean val)

getRememberMe

public boolean getRememberMe()

setRememberMePassphrase

public void setRememberMePassphrase(java.lang.String val)

getRememberMePassphrase

public java.lang.String getRememberMePassphrase()

setForgotPasswordPrimary

public void setForgotPasswordPrimary(java.lang.String val)

getForgotPasswordPrimary

public java.lang.String getForgotPasswordPrimary()

setForgotPasswordSecondary

public void setForgotPasswordSecondary(java.lang.String val)

getForgotPasswordSecondary

public java.lang.String getForgotPasswordSecondary()

setMaxInactiveMinutes

public void setMaxInactiveMinutes(java.lang.String val)

getMaxInactiveMinutes

public java.lang.String getMaxInactiveMinutes()

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Add ourselves to our project so the generators have access to this information.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException