Package com.sun.enterprise.config.serverbeans

Interface AdminService

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag

public interface AdminService
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag

Admin Service exists in every instance. It is the configuration for either a normal server, DAS or PE instance

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AdminService.Duck

Method Summary

Modifier and Type	Method	Description
AuthRealm	getAssociatedAuthRealm()
@NotNull String	getAuthRealmName()	Gets the name of the auth realm to be used for administration.
@NotNull DasConfig	getDasConfig()	Gets the value of the dasConfig property.
List<JmxConnector>	getJmxConnector()	Gets the value of the jmxConnector property.
List<org.jvnet.hk2.config.types.Property>	getProperty()	Properties as per PropertyBag
JmxConnector	getSystemJmxConnector()
String	getSystemJmxConnectorName()	Gets the value of the systemJmxConnectorName property.
@Pattern(regexp="(das|das-and-server|server)") String	getType()	Gets the value of the type property.
void	setAuthRealmName(String name)
void	setDasConfig(DasConfig value)	Sets the value of the dasConfig property.
void	setSystemJmxConnectorName(String value)	Sets the value of the systemJmxConnectorName property.
void	setType(String value)	Sets the value of the type property.
boolean	usesFileRealm()

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Method Detail

getType

@Pattern(regexp="(das|das-and-server|server)")
@Pattern(regexp="(das|das-and-server|server)") String getType()

Gets the value of the type property. An instance can either be of type das Domain Administration Server in SE/EE or the PE instance das-and-server same as das server Any non-DAS instance in SE/EE. Not valid for PE.

Returns:

possible object is String

setType

void setType(String value)
      throws PropertyVetoException

Sets the value of the type property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSystemJmxConnectorName

String getSystemJmxConnectorName()

Gets the value of the systemJmxConnectorName property. The name of the internal jmx connector

Returns:

possible object is String

setSystemJmxConnectorName

void setSystemJmxConnectorName(String value)
                        throws PropertyVetoException

Sets the value of the systemJmxConnectorName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getJmxConnector

List<JmxConnector> getJmxConnector()

Gets the value of the jmxConnector property. The jmx-connector element defines the configuration of a JSR 160 compliant remote JMX Connector. Objects of the following type(s) are allowed in the list JmxConnector

getDasConfig

@NotNull
@NotNull DasConfig getDasConfig()

Gets the value of the dasConfig property.

Returns:

possible object is DasConfig

setDasConfig

void setDasConfig(DasConfig value)
           throws PropertyVetoException

Sets the value of the dasConfig property.

Parameters:

value - allowed object is DasConfig

Throws:

PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<org.jvnet.hk2.config.types.Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface org.jvnet.hk2.config.types.PropertyBag

getAuthRealmName

@NotNull
@NotNull String getAuthRealmName()

Gets the name of the auth realm to be used for administration. This obsoletes/deprecates the similarly named attribute on JmxConnector. Note that this is of essence where admin access is done outside the containers. Container managed security is still applicable and is handled via security annotations and deployment descriptors of the admin applications (aka admin GUI application, MEjb application).

Returns:

name of the auth realm to be used for admin access

setAuthRealmName

void setAuthRealmName(String name)

getSystemJmxConnector

@DuckTyped
JmxConnector getSystemJmxConnector()

getAssociatedAuthRealm

@DuckTyped
AuthRealm getAssociatedAuthRealm()

usesFileRealm

@DuckTyped
boolean usesFileRealm()