com.sun.enterprise.config.serverbeans

Interface JmxConnector

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, jakarta.validation.Payload, org.jvnet.hk2.config.types.PropertyBag

@ReferenceConstraint(skipDuringCreation=true,
                     payload=JmxConnector.class)
public interface JmxConnector
extends org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, org.jvnet.hk2.config.types.PropertyBag, jakarta.validation.Payload

The jmx-connector element defines the configuration of a JSR 160 compliant remote JMX Connector.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

org.jvnet.hk2.config.ConfigBeanProxy.Duck

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

org.jvnet.hk2.config.types.PropertyBag.Duck

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORT_PATTERN

Method Summary

Modifier and Type	Method and Description
String	getAcceptAll() Gets the value of the acceptAll property.
@NotNull String	getAddress() Gets the value of the address property.
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String	getAuthRealmName() Deprecated.
String	getEnabled() Gets the value of the enabled property.
@Pattern(regexp="\\$\\{[\\p{L}\\p{N}_][\\p{L}\\p{N}\\-_./;#]*\\}|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-5][0-9][0-9][0-9][0-9]|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5]",message="{port-pattern}",payload=JmxConnector.class) String	getPort() Gets the value of the port property.
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
String	getProtocol() Gets the value of the protocol property.
String	getSecurityEnabled() Gets the value of the securityEnabled property.
org.glassfish.grizzly.config.dom.Ssl	getSsl() Gets the value of the ssl property.
void	setAcceptAll(String value) Sets the value of the acceptAll property.
void	setAddress(String value) Sets the value of the address property.
void	setAuthRealmName(String value) Sets the value of the authRealmName property.
void	setEnabled(String value) Sets the value of the enabled property.
void	setPort(String value) Sets the value of the port property.
void	setProtocol(String value) Sets the value of the protocol property.
void	setSecurityEnabled(String value) Sets the value of the securityEnabled property.
void	setSsl(org.glassfish.grizzly.config.dom.Ssl value) Sets the value of the ssl property.

Methods inherited from interface org.glassfish.api.admin.config.Named

getName, setName

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

Field Detail

PORT_PATTERN

static final String PORT_PATTERN

See Also:

Constant Field Values

Method Detail

getEnabled

String getEnabled()

Gets the value of the enabled property. Defines if this connector is enabled. For EE this must be enabled

Returns:

possible object is String

setEnabled

void setEnabled(String value)
         throws PropertyVetoException

Sets the value of the enabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getProtocol

String getProtocol()

Gets the value of the protocol property. Defines the protocol that this jmx-connector should support. Supported protocols are defined by Entity rjmx-protocol. Other protocols can be used by user applications independently.

Returns:

possible object is String

setProtocol

void setProtocol(String value)
          throws PropertyVetoException

Sets the value of the protocol property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAddress

@NotNull
@NotNull String getAddress()

Gets the value of the address property. Specifies the IP address or host-name.

Returns:

possible object is String

setAddress

void setAddress(String value)
         throws PropertyVetoException

Sets the value of the address property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPort

@Pattern(regexp="\\$\\{[\\p{L}\\p{N}_][\\p{L}\\p{N}\\-_./;#]*\\}|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-5][0-9][0-9][0-9][0-9]|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5]",
         message="{port-pattern}",
         payload=JmxConnector.class)
@Pattern(regexp="\\$\\{[\\p{L}\\p{N}_][\\p{L}\\p{N}\\-_./;#]*\\}|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-5][0-9][0-9][0-9][0-9]|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5]",message="{port-pattern}",payload=JmxConnector.class) String getPort()

Gets the value of the port property. Specifies the port of the jmx-connector-server. Note that jmx-service-url is a function of protocol, port and address as defined by the JSR 160 1.0 Specification.

Returns:

possible object is String

setPort

void setPort(String value)
      throws PropertyVetoException

Sets the value of the port property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAcceptAll

String getAcceptAll()

Gets the value of the acceptAll property. Determines whether the connection can be made on all the network interfaces. A value of false implies that the connections only for this specific address will be selected.

Returns:

possible object is String

setAcceptAll

void setAcceptAll(String value)
           throws PropertyVetoException

Sets the value of the acceptAll property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAuthRealmName

@Deprecated
 @NotNull
 @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*")
 @ReferenceConstraint.RemoteKey(message="{resourceref.invalid.auth-realm-name}",
                               type=AuthRealm.class)
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String getAuthRealmName()

Deprecated.

Gets the value of the auth-realm-name property. The name of the auth-realm in this config element that represents the special administrative realm. All authentication (from administraive GUI and CLI) will be handled by this realm. Note: This is deprecated since GlassFish v3 FCS. Use similarly named attribute on admin-service. This will be used only when the admin-service attribute in missing.

Returns:

String representing the name of auth realm

setAuthRealmName

void setAuthRealmName(String value)
               throws PropertyVetoException

Sets the value of the authRealmName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSecurityEnabled

String getSecurityEnabled()

Gets the value of the securityEnabled property. Decides whether the transport layer security be used in jmx-connector. If true, configure the ssl element

Returns:

possible object is String

setSecurityEnabled

void setSecurityEnabled(String value)
                 throws PropertyVetoException

Sets the value of the securityEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSsl

org.glassfish.grizzly.config.dom.Ssl getSsl()

Gets the value of the ssl property.

Returns:

possible object is Ssl

setSsl

void setSsl(org.glassfish.grizzly.config.dom.Ssl value)
     throws PropertyVetoException

Sets the value of the ssl property.

Parameters:

value - allowed object is Ssl

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