public final class J2eePlatform extends Object implements Lookup.Provider
Modifier and Type | Field and Description |
---|---|
static String |
CLIENT_PROP_DIST_ARCHIVE
Constant for the distribution archive client property.
|
static String |
LIBRARY_TYPE
Deprecated.
|
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.
|
Modifier and Type | Method and Description |
---|---|
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)
Deprecated.
|
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.
|
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.
|
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.
|
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.
J2eePlatform.getLookup() should be used to obtain tool specifics |
int |
hashCode() |
boolean |
isToolSupported(String toolName)
Deprecated.
J2eePlatform.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() |
@Deprecated public static final String LIBRARY_TYPE
J2eePlatform.createLibrary(File, String)
.public static final String PROP_DISPLAY_NAME
public static final String PROP_CLASSPATH
public static final String PROP_PLATFORM_ROOTS
public static final String TOOL_APP_CLIENT_RUNTIME
J2eePlatform.TOOL_PROP_MAIN_CLASS
,
J2eePlatform.TOOL_PROP_MAIN_CLASS_ARGS
, J2eePlatform.TOOL_PROP_JVM_OPTS
public static final String TOOL_JSR109
public static final String TOOL_WSCOMPILE
public static final String TOOL_EMBEDDABLE_EJB
public static final String TOOL_WSIMPORT
public static final String TOOL_WSGEN
public static final String TOOL_WSIT
public static final String TOOL_JWSDP
public static final String TOOL_KEYSTORE
public static final String TOOL_KEYSTORE_CLIENT
public static final String TOOL_TRUSTSTORE
public static final String TOOL_TRUSTSTORE_CLIENT
public static final String TOOL_PROP_MAIN_CLASS
public static final String TOOL_PROP_MAIN_CLASS_ARGS
public static final String TOOL_PROP_JVM_OPTS
public static final String TOOL_PROP_CLIENT_JAR_LOCATION
public static final String CLIENT_PROP_DIST_ARCHIVE
@NonNull public File[] getClasspathEntries()
@NonNull public File[] getClasspathEntries(Set<ServerLibraryDependency> libraries)
public File[] getToolClasspathEntries(String toolName)
toolName
- tool name, for example J2eePlatform.TOOL_APP_CLIENT_RUNTIME
.@Deprecated public String getToolProperty(String toolName, String propertyName)
J2eePlatform.getLookup()
should be used to obtain tool specificsThe 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
J2eePlatform.CLIENT_PROP_DIST_ARCHIVE
toolName
- tool name, for example J2eePlatform.TOOL_APP_CLIENT_RUNTIME
.propertyName
- tool property name, for example J2eePlatform.TOOL_PROP_MAIN_CLASS
.@Deprecated public boolean isToolSupported(String toolName)
J2eePlatform.getLookup()
should be used to obtain tool specificstoolName
- tool name, for example J2eePlatform.TOOL_APP_CLIENT_RUNTIME
.true
if platform supports tool of the given name,
false
otherwise.public String getDisplayName()
public Image getIcon()
@Deprecated public File[] getPlatformRoots()
J2eePlatform.getServerHome()
or J2eePlatform.getDomainHome()
or J2eePlatform.getMiddlewareHome()
@CheckForNull public File getServerHome()
null
if not
specified or unknown.null
if not
specified or unknownJ2eePlatformImpl2.getServerHome()
@CheckForNull public File getDomainHome()
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.null
if not
specified or unknownJ2eePlatformImpl2.getDomainHome()
@CheckForNull public File getMiddlewareHome()
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.null
if not
specified or unknownJ2eePlatformImpl2.getMiddlewareHome()
@Deprecated public Set getSupportedSpecVersions()
J2eePlatform.getSupportedProfiles()
J2eeModule
class.@Deprecated public Set<String> getSupportedSpecVersions(Object moduleType)
#getSupportedProfiles(java.lang.Object)
moduleType
- one of the constants defined in
J2eeModule
@NonNull public Set<org.netbeans.api.j2ee.core.Profile> getSupportedProfiles()
@NonNull public Set<org.netbeans.api.j2ee.core.Profile> getSupportedProfiles(@NonNull J2eeModule.Type moduleType)
J2eeModule.EAR
,
J2eeModule.EJB
, J2eeModule.WAR
, J2eeModule#RAR
and J2eeModule#CAR
).@Deprecated public Set getSupportedModuleTypes()
J2eePlatform.getSupportedTypes()
J2eeModule
class.public Set<J2eeModule.Type> getSupportedTypes()
J2eeModule.Type
class.public Set getSupportedJavaPlatformVersions()
public boolean supportsProfiling()
public JavaPlatform getJavaPlatform()
public void addPropertyChangeListener(PropertyChangeListener l)
l
- listener which should be added.public void removePropertyChangeListener(PropertyChangeListener l)
l
- listener which should be removed.@Deprecated public Library createLibrary(File location, String libraryName) throws IOException
location
- sharable libraries locationlibraryName
- name of the libraryIOException
- if the library can't be created for some reasonpublic Lookup getLookup()
getLookup
in interface Lookup.Provider