|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.borland.jbuilder.paths.PathSet | +--com.borland.jbuilder.enterprise.ejb.AppServer
This class should be extended to refer to an application server that will be used in JBuilder. All such implementations will be loaded at open-tools reading time, and will be available from the Enterprise tab of the Project Properties dialog. If the project gets saved, application server values get saved in a appserver.properties file, and will include any changes the user made to the default settings (i.e. VM parameters). The next time the project is opened, the application server property values will be loaded from the appserver.properties file.
Fields inherited from class com.borland.jbuilder.paths.PathSet |
collection, EMPTY_ARRAY, hasChanged, lastFullUpdate, lastModified, requiredNames |
Constructor Summary | |
AppServer()
|
|
AppServer(java.lang.String name)
|
Method Summary | |
abstract java.lang.String |
customizeParameters(java.lang.String currentParameters,
java.util.ArrayList ejbJarFiles,
Project project,
java.util.Map propertyMap)
This routine is called before the appServer parameters are used, just in case some special parameters need to be added that include the ejb jar files (i.e. |
abstract java.lang.String |
customizeVmParameters(java.lang.String currentVmParameters,
java.util.ArrayList ejbJarFiles,
Project project,
java.util.Map propertyMap)
This routine is called before the vm parameters are used, just in case some special parameters need to be added that include the ejb jar files (i.e. |
void |
deploy(java.lang.String[] ejbJars)
Runs whatever tool is appropriate for this application server to deploy the argument jar files. |
java.lang.String |
getClassName()
|
abstract java.lang.String |
getDefaultClassName()
|
abstract Url[] |
getDefaultClassPath()
This function returns the array of default directories/.jars that are necessary to run this appserver. |
abstract Url |
getDefaultHomeDirectory()
This function returns the default home directory for this appserver |
abstract java.lang.String |
getDefaultName()
|
abstract java.lang.String |
getDefaultNecessaryParameters()
These parameters are ones without which the app server will not run. |
abstract java.lang.String |
getDefaultNecessaryVmParameters()
These VM parameters are ones without which the app server will not run. |
abstract java.lang.String |
getDefaultParameters()
|
abstract java.lang.String |
getDefaultServerName()
Returns a name that is used to uniquely identify the current instance of the application server. |
abstract java.lang.String |
getDefaultVersion()
|
abstract java.lang.String |
getDefaultVmParameters()
|
EjbDeployer |
getEjbDeployer()
|
protected java.lang.String |
getFileNameBasedOnProtocol(java.lang.String protocol,
java.lang.String name)
|
java.lang.String |
getFullClassPathString()
|
java.lang.String |
getFullName()
|
Url |
getHomeDirectory()
|
static java.lang.String |
getNameFromFullName(java.lang.String fullName)
This function retrieves just the name part of the full name. |
java.lang.String |
getNecessaryParameters()
|
java.lang.String |
getNecessaryVmParameters()
|
java.lang.String |
getNewParametersBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
|
Url[] |
getNewPathsBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
Returns a Url[] paths list based on the newHomeDirectory. |
java.lang.String |
getNewVmParametersBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
|
java.lang.String |
getParameters()
|
static AppServerTargeting |
getRegisteredTargeting(java.lang.String name,
java.lang.String version)
Returns the last registered AppServerTargeting for the given name or a default implementation if none found. |
AppServerTargeting |
getTargeting()
Returns the targeting interface class. |
Url[] |
getUniqueRunDebugClassPath(Url[] checkClassPath)
|
java.lang.String |
getVersion()
|
java.lang.String |
getVmParameters()
|
boolean |
hasEjbDeployer()
|
boolean |
isDefault()
|
abstract boolean |
isSetup()
This function is useful if the app server has a setup defined that needs to be run before this app server can actually be used. |
abstract java.lang.String |
isValidSetupDirectory(java.lang.String setupDirectory)
This function is useful if the app server has a setup defined that needs to be run before this AppServer can actually be used. |
static java.lang.String |
makeFullName(java.lang.String name,
java.lang.String version)
This function defines a mechanism for getting the full name of an appServer. |
static void |
registerTargeting(java.lang.String name,
java.lang.String version,
AppServerTargeting targeting)
OpenTools registration for an interface used to provide customization and verify of deployment descriptors. |
void |
restoreFrom(AppServer appServer)
|
void |
setClassName(java.lang.String className)
Sets the className for this AppServer |
void |
setEjbDeployer(EjbDeployer ejbDeployer)
|
void |
setHomeDirectory(Url homeDirectory)
Sets the home directory for this AppServer. |
void |
setName(java.lang.String name)
Changes this PathSet's name. |
void |
setNecessaryParameters(java.lang.String necessaryParameters)
Sets parameters without which this AppServer cannot be run. |
void |
setNecessaryVmParameters(java.lang.String necessaryVmParameters)
Sets VM parameters without which this AppServer cannot be run. |
void |
setParameters(java.lang.String parameters)
Sets the parameters with which this AppServer should be run. |
void |
setVersion(java.lang.String version)
Sets the version for this AppServer |
void |
setVmParameters(java.lang.String vmParameters)
Sets the VM parameters used to run this AppServer. |
abstract boolean |
shutdown(Project project,
java.util.Map propertyMap,
RunJavaProcessTracker tracker)
This function is called before the appserver process terminates. |
abstract boolean |
supportsMinimalJars()
|
abstract boolean |
supportsPoolNames()
This function indicates whether the appserver supports the specification of a pool name in the deployment descriptor of CMP entity beans. |
abstract boolean |
supportsPrimitivePrimaryKeys()
This function indicates whether the appserver allows single field primary keys to be primitive types, or whether they must be classes. |
void |
updateClassPathWithNewHomeDirectory(java.lang.String newHomeDirectory)
Modifies the current classpath to use new home directory as base for all directoriess that start with the old home directory. |
protected void |
updateLastModified()
Records a new last modified date for this path set and updates the global last updated time so that other path sets can rebuild their "full path" cache. |
abstract void |
updateSetup(java.awt.Component owner)
This function is useful if the app server has a setup defined that needs to be run before this app server can actually be used. |
Methods inherited from class com.borland.jbuilder.paths.PathSet |
addEntries, addUniquePath, addUniquePath, addUniquePaths, addUniquePathsIfEnabled, buildFullPaths, delete, getClassPath, getCollection, getDocPath, getFullClassPath, getFullDocPath, getFullSourcePath, getLastModified, getName, getNames, getNames, getRequired, getRequiredNames, getResolver, getSourcePath, getUrl, isEmpty, isEnabled, isReadOnly, load, parseLibraries, resolveRequired, save, setClassPath, setCollection, setDocPath, setRequired, setRequired, setRequired, setSourcePath, setUrl, updateFullPaths |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AppServer()
public AppServer(java.lang.String name)
Method Detail |
public static void registerTargeting(java.lang.String name, java.lang.String version, AppServerTargeting targeting)
name
- Name of AppServer.version
- Version of AppServer.targeting
- An interface which can provide target AppServer deployment descriptors.public static AppServerTargeting getRegisteredTargeting(java.lang.String name, java.lang.String version)
name
- Name of AppServer.version
- Version of AppServer.public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- The version string of the AppServerpublic java.lang.String getClassName()
public void setClassName(java.lang.String className)
className
- The name of the class used to run/debug this AppServerpublic java.lang.String getParameters()
public void setParameters(java.lang.String parameters)
parameters
- The parameters for this AppServer when it is run/debuggedpublic java.lang.String getNecessaryParameters()
public void setNecessaryParameters(java.lang.String necessaryParameters)
public java.lang.String getVmParameters()
public void setVmParameters(java.lang.String vmParameters)
vmParameters
- The VM parameters for running/debugging this AppServerpublic java.lang.String getNecessaryVmParameters()
public void setNecessaryVmParameters(java.lang.String necessaryVmParameters)
public Url getHomeDirectory()
public void setHomeDirectory(Url homeDirectory)
homeDirectory
- The home directory for this AppServerpublic void setEjbDeployer(EjbDeployer ejbDeployer)
public EjbDeployer getEjbDeployer()
public void restoreFrom(AppServer appServer)
public java.lang.String getFullClassPathString()
public Url[] getNewPathsBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
protected java.lang.String getFileNameBasedOnProtocol(java.lang.String protocol, java.lang.String name)
public void updateClassPathWithNewHomeDirectory(java.lang.String newHomeDirectory)
public java.lang.String getNewVmParametersBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
public java.lang.String getNewParametersBasedOnNewHomeDirectory(java.lang.String newHomeDirectory)
public boolean isDefault()
public boolean hasEjbDeployer()
public void deploy(java.lang.String[] ejbJars)
ejbJars
- The array of jars to be deployed.public static java.lang.String makeFullName(java.lang.String name, java.lang.String version)
public static java.lang.String getNameFromFullName(java.lang.String fullName)
fullName
- The full name of the AppServer -- made up of name and versionpublic java.lang.String getFullName()
public Url[] getUniqueRunDebugClassPath(Url[] checkClassPath)
checkClassPath
- The classpath to which we want to prepend ourspublic void setName(java.lang.String name)
PathSet
setName
in class PathSet
com.borland.jbuilder.paths.PathSet
name
- A new name for the PathSet. This value may not be null.protected void updateLastModified()
PathSet
Records a new last modified date for this path set and updates the global last updated time so that other path sets can rebuild their "full path" cache.
Any method that modifies the state of the PathSet should invoke this method as a side-effect.
updateLastModified
in class PathSet
public abstract java.lang.String getDefaultName()
public abstract java.lang.String getDefaultVersion()
public abstract java.lang.String getDefaultClassName()
public abstract java.lang.String getDefaultParameters()
public abstract java.lang.String getDefaultNecessaryParameters()
public abstract java.lang.String getDefaultVmParameters()
public abstract java.lang.String getDefaultNecessaryVmParameters()
public abstract Url getDefaultHomeDirectory()
public AppServerTargeting getTargeting()
public abstract Url[] getDefaultClassPath()
public abstract java.lang.String getDefaultServerName()
public abstract java.lang.String customizeVmParameters(java.lang.String currentVmParameters, java.util.ArrayList ejbJarFiles, Project project, java.util.Map propertyMap)
public abstract java.lang.String customizeParameters(java.lang.String currentParameters, java.util.ArrayList ejbJarFiles, Project project, java.util.Map propertyMap)
public abstract boolean supportsMinimalJars()
public abstract boolean shutdown(Project project, java.util.Map propertyMap, RunJavaProcessTracker tracker)
propertyMap
- The map of properties this AppServer was started withtracker
- The tracker used to display the run/debug for this AppServerpublic abstract boolean supportsPrimitivePrimaryKeys()
public abstract boolean supportsPoolNames()
public abstract boolean isSetup()
public abstract java.lang.String isValidSetupDirectory(java.lang.String setupDirectory)
setupDirectory
- The directory used to setup the app serverpublic abstract void updateSetup(java.awt.Component owner)
owner
- The component that will be the owning control of any dialogs
that come up during the update.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |