org.netbeans.modules.j2ee.deployment.devmodules.api
Class J2eePlatform

java.lang.Object
  org.netbeans.modules.j2ee.deployment.devmodules.api.J2eePlatform

All Implemented Interfaces:

Lookup.Provider

public final class J2eePlatform
extends Object
implements Lookup.Provider

J2eePlatform describes the target environment J2EE applications are build against and subsequently deployed to. Each server instance defines its own J2EE platform.

Since:

1.5

Field Summary

static String	CLIENT_PROP_DIST_ARCHIVE Constant for the distribution archive client property.
static String	LIBRARY_TYPE Type of the library created by createLibrary(File, String).
static String	PROP_CLASSPATH Classpath property
static String	PROP_DISPLAY_NAME Display name property
static String	PROP_PLATFORM_ROOTS Platform roots property
static String	TOOL_APP_CLIENT_RUNTIME Constant for the application runtime tool.
static String	TOOL_EMBEDDABLE_EJB Constant for the embedabble EJB (Java EE 6).
static String	TOOL_JSR109 Constant for the JSR109 tool.
static String	TOOL_JWSDP Constant for the JWSDP tool.
static String	TOOL_KEYSTORE Constant for the KEYSTORE tool.
static String	TOOL_KEYSTORE_CLIENT Constant for the KEYSTORE_CLIENT tool.
static String	TOOL_PROP_CLIENT_JAR_LOCATION Tool property constant for application client jar location.
static String	TOOL_PROP_JVM_OPTS Constant for the JVM options tool property.
static String	TOOL_PROP_MAIN_CLASS Constant for the main class tool property.
static String	TOOL_PROP_MAIN_CLASS_ARGS Constant for the main class arguments tool property.
static String	TOOL_TRUSTSTORE Constant for the TRUSTSTORE tool.
static String	TOOL_TRUSTSTORE_CLIENT Constant for the TRUSTSTORE_CLIENT tool.
static String	TOOL_WSCOMPILE Constant for the WSCOMPILE tool.
static String	TOOL_WSGEN Constant for the WSGEN tool.
static String	TOOL_WSIMPORT Constant for the WSIMPORT tool.
static String	TOOL_WSIT Constant for the WSIT tool.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Register a listener which will be notified when some of the platform's properties change.
Library	createLibrary(File location, String libraryName) Creates sharable Java library containing all libraries and sources provided by this platform.
boolean	equals(Object obj)
File[]	getClasspathEntries() Return classpath entries.
File[]	getClasspathEntries(Set<ServerLibraryDependency> libraries)
String	getDisplayName() Return platform's display name.
File	getDomainHome() Returns the domain directory or null if not specified or unknown.
Image	getIcon() Return platform's icon.
JavaPlatform	getJavaPlatform() Return server J2SE platform or null if the platform is unknown, not registered in the IDE.
Lookup	getLookup() Lookup providing a way to find non mandatory technologies supported by the platform.
File	getMiddlewareHome() Returns the middleware directory or null if not specified or unknown.
File[]	getPlatformRoots() Deprecated. use getServerHome() or getDomainHome() or getMiddlewareHome()
File	getServerHome() Returns the server installation directory or null if not specified or unknown.
Set	getSupportedJavaPlatformVersions() Return a set of J2SE platform versions this J2EE platform can run with.
Set	getSupportedModuleTypes() Deprecated. use getSupportedTypes()
Set<org.netbeans.api.j2ee.core.Profile>	getSupportedProfiles() Returns the set of supported profiles (terminology of Java EE 6).
Set<org.netbeans.api.j2ee.core.Profile>	getSupportedProfiles(J2eeModule.Type moduleType) Returns the set of supported profiles (terminology of Java EE 6) for the given module type (one of J2eeModule.EAR, J2eeModule.EJB, J2eeModule.WAR, J2eeModule#RAR and J2eeModule#CAR).
Set	getSupportedSpecVersions() Deprecated. use getSupportedProfiles()
Set<String>	getSupportedSpecVersions(Object moduleType) Deprecated. use #getSupportedProfiles(java.lang.Object)
Set<J2eeModule.Type>	getSupportedTypes() Return a list of supported module types.
File[]	getToolClasspathEntries(String toolName) Return classpath for the specified tool.
String	getToolProperty(String toolName, String propertyName) Deprecated. getLookup() should be used to obtain tool specifics
int	hashCode()
boolean	isToolSupported(String toolName) Deprecated. getLookup() should be used to obtain tool specifics
void	removePropertyChangeListener(PropertyChangeListener l) Remove a listener registered previously.
boolean	supportsProfiling() Is profiling supported by this J2EE platform?
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LIBRARY_TYPE

public static final String LIBRARY_TYPE

Type of the library created by createLibrary(File, String).

Since:

1.40

See Also:

Constant Field Values

PROP_DISPLAY_NAME

public static final String PROP_DISPLAY_NAME

Display name property

See Also:

Constant Field Values

PROP_CLASSPATH

public static final String PROP_CLASSPATH

Classpath property

See Also:

Constant Field Values

PROP_PLATFORM_ROOTS

public static final String PROP_PLATFORM_ROOTS

Platform roots property

See Also:

Constant Field Values

TOOL_APP_CLIENT_RUNTIME

public static final String TOOL_APP_CLIENT_RUNTIME

Constant for the application runtime tool. The standard properties defined for this tool are as follows TOOL_PROP_MAIN_CLASS, TOOL_PROP_MAIN_CLASS_ARGS, TOOL_PROP_JVM_OPTS

Since:

1.16

See Also:

Constant Field Values

TOOL_JSR109

public static final String TOOL_JSR109

Constant for the JSR109 tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_WSCOMPILE

public static final String TOOL_WSCOMPILE

Constant for the WSCOMPILE tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_EMBEDDABLE_EJB

public static final String TOOL_EMBEDDABLE_EJB

Constant for the embedabble EJB (Java EE 6).

Since:

1.60

See Also:

Constant Field Values

TOOL_WSIMPORT

public static final String TOOL_WSIMPORT

Constant for the WSIMPORT tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_WSGEN

public static final String TOOL_WSGEN

Constant for the WSGEN tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_WSIT

public static final String TOOL_WSIT

Constant for the WSIT tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_JWSDP

public static final String TOOL_JWSDP

Constant for the JWSDP tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_KEYSTORE

public static final String TOOL_KEYSTORE

Constant for the KEYSTORE tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_KEYSTORE_CLIENT

public static final String TOOL_KEYSTORE_CLIENT

Constant for the KEYSTORE_CLIENT tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_TRUSTSTORE

public static final String TOOL_TRUSTSTORE

Constant for the TRUSTSTORE tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_TRUSTSTORE_CLIENT

public static final String TOOL_TRUSTSTORE_CLIENT

Constant for the TRUSTSTORE_CLIENT tool.

Since:

1.16

See Also:

Constant Field Values

TOOL_PROP_MAIN_CLASS

public static final String TOOL_PROP_MAIN_CLASS

Constant for the main class tool property.

Since:

1.16

See Also:

Constant Field Values

TOOL_PROP_MAIN_CLASS_ARGS

public static final String TOOL_PROP_MAIN_CLASS_ARGS

Constant for the main class arguments tool property.

Since:

1.16

See Also:

Constant Field Values

TOOL_PROP_JVM_OPTS

public static final String TOOL_PROP_JVM_OPTS

Constant for the JVM options tool property.

Since:

1.16

See Also:

Constant Field Values

TOOL_PROP_CLIENT_JAR_LOCATION

public static final String TOOL_PROP_CLIENT_JAR_LOCATION

Tool property constant for application client jar location.

Since:

1.40

See Also:

Constant Field Values

CLIENT_PROP_DIST_ARCHIVE

public static final String CLIENT_PROP_DIST_ARCHIVE

Constant for the distribution archive client property. Some of the tool property values may refer to this property.

Since:

1.16

See Also:

Constant Field Values

Method Detail

getClasspathEntries

@NonNull
public File[] getClasspathEntries()

Return classpath entries.

Returns:

classpath entries.

getClasspathEntries

@NonNull
public File[] getClasspathEntries(Set<ServerLibraryDependency> libraries)

getToolClasspathEntries

public File[] getToolClasspathEntries(String toolName)

Return classpath for the specified tool. Use the tool constants declared in this class.

Parameters:

toolName - tool name, for example TOOL_APP_CLIENT_RUNTIME.

Returns:

classpath for the specified tool.

getToolProperty

public String getToolProperty(String toolName,
                              String propertyName)

Deprecated. getLookup() should be used to obtain tool specifics

Returns the property value for the specified tool.

The property value uses Ant property format and therefore may contain references to another properties defined either by the client of this API or by the tool itself.

The properties the client may be requited to define are as follows CLIENT_PROP_DIST_ARCHIVE

Parameters:

toolName - tool name, for example TOOL_APP_CLIENT_RUNTIME.

propertyName - tool property name, for example TOOL_PROP_MAIN_CLASS.

Returns:

property value or null, if the property is not defined for the specified tool.

Since:

1.16

isToolSupported

public boolean isToolSupported(String toolName)

Deprecated. getLookup() should be used to obtain tool specifics

Specifies whether a tool of the given name is supported by this platform. Use the tool constants declared in this class.

Parameters:

toolName - tool name, for example TOOL_APP_CLIENT_RUNTIME.

Returns:

true if platform supports tool of the given name, false otherwise.

getDisplayName

public String getDisplayName()

Return platform's display name.

Returns:

platform's display name.

getIcon

public Image getIcon()

Return platform's icon.

Returns:

platform's icon.

Since:

1.6

getPlatformRoots

public File[] getPlatformRoots()

Deprecated. use getServerHome() or getDomainHome() or getMiddlewareHome()

Return platform's root directories. This will be mostly server's installation directory.

Returns:

platform's root directories.

getServerHome

@CheckForNull
public File getServerHome()

Returns the server installation directory or null if not specified or unknown.

Returns:

the server installation directory or null if not specified or unknown

Since:

1.72

See Also:

J2eePlatformImpl2.getServerHome()

getDomainHome

@CheckForNull
public File getDomainHome()

Returns the domain directory or null if not specified or unknown. Many Java EE servers allows usage of multiple server instances using single binaries. In such case this method should return the installation/configuration directory of such instance.

Returns:

the domain directory or null if not specified or unknown

Since:

1.72

See Also:

J2eePlatformImpl2.getDomainHome()

getMiddlewareHome

@CheckForNull
public File getMiddlewareHome()

Returns the middleware directory or null if not specified or unknown. Some servers share certain binaries on higher level with other products of the same vendor. In such case this method should return the appropriate directory.

Returns:

the middleware directory or null if not specified or unknown

Since:

1.72

See Also:

J2eePlatformImpl2.getMiddlewareHome()

getSupportedSpecVersions

public Set getSupportedSpecVersions()

Deprecated. use getSupportedProfiles()

Return a list of supported J2EE specification versions. Use J2EE specification versions defined in the J2eeModule class.

Returns:

list of supported J2EE specification versions.

getSupportedSpecVersions

public Set<String> getSupportedSpecVersions(Object moduleType)

Deprecated. use #getSupportedProfiles(java.lang.Object)

Return a list of supported J2EE specification versions for a given module type.

Parameters:

moduleType - one of the constants defined in J2eeModule

Returns:

list of supported J2EE specification versions.

getSupportedProfiles

@NonNull
public Set<org.netbeans.api.j2ee.core.Profile> getSupportedProfiles()

Returns the set of supported profiles (terminology of Java EE 6). There are also profiles for J2EE 1.4 and Java EE 5.

Returns:

set of Profiles supported by the server.

Since:

1.58

See Also:

Profile

getSupportedProfiles

@NonNull
public Set<org.netbeans.api.j2ee.core.Profile> getSupportedProfiles(@NonNull
                                                                            J2eeModule.Type moduleType)

Returns the set of supported profiles (terminology of Java EE 6) for the given module type (one of J2eeModule.EAR, J2eeModule.EJB, J2eeModule.WAR, J2eeModule#RAR and J2eeModule#CAR).

Parameters:

moduleType - type of the module

Returns:

set of Profiles supported by the server.

Since:

1.59

See Also:

Profile

getSupportedModuleTypes

public Set getSupportedModuleTypes()

Deprecated. use getSupportedTypes()

Return a list of supported J2EE module types. Use module types defined in the J2eeModule class.

Returns:

list of supported J2EE module types.

getSupportedTypes

public Set<J2eeModule.Type> getSupportedTypes()

Return a list of supported module types. Use module types defined in the J2eeModule.Type class.

Returns:

set of supported module types

Since:

1.59

getSupportedJavaPlatformVersions

public Set getSupportedJavaPlatformVersions()

Return a set of J2SE platform versions this J2EE platform can run with. Versions should be specified as strings i.g. ("1.3", "1.4", etc.)

Returns:

set of J2SE platform versions this J2EE platform can run with.

Since:

1.9

supportsProfiling

public boolean supportsProfiling()

Is profiling supported by this J2EE platform?

Returns:

true, if profiling is supported, false otherwise.

Since:

1.9

getJavaPlatform

public JavaPlatform getJavaPlatform()

Return server J2SE platform or null if the platform is unknown, not registered in the IDE.

Returns:

server J2SE platform or null if the platform is unknown, not registered in the IDE.

Since:

1.9

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Register a listener which will be notified when some of the platform's properties change.

Parameters:

l - listener which should be added.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Remove a listener registered previously.

Parameters:

l - listener which should be removed.

toString

public String toString()

Overrides:

toString in class Object

createLibrary

public Library createLibrary(File location,
                             String libraryName)
                      throws IOException

Creates sharable Java library containing all libraries and sources provided by this platform. All files are copied to shared location and library is created.

Parameters:

location - sharable libraries location

libraryName - name of the library

Returns:

created library

Throws:

IOException - if the library can't be created for some reason

Since:

1.40

getLookup

public Lookup getLookup()

Lookup providing a way to find non mandatory technologies supported by the platform.

The typical example of such support is a webservice stack.

Specified by:

getLookup in interface Lookup.Provider

Returns:

Lookup providing way to find other supported technologies

Since:

1.44

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object