Skip navigation links

weblogic.management.configuration
Interface VirtualTargetMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, TargetMBean, WebLogicMBean

public interface VirtualTargetMBean

extends DeploymentMBean, TargetMBean

This bean represents a target for a resource group in a partition. It defines access point to resources, i.e. hostname, port, partition uri path. Moreover, it provide configurations for each protocol, for example, http, t3, ssl, iiop etc.

Since:

12.2.1.0

getName

String getName()

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Specified by:

getName in interface ConfigurationMBean

Specified by:

getName in interface WebLogicMBean

getHostNames

String[] getHostNames()

The list of host names for which this virtual target serves requests.

Returns:

The hostNames value

setHostNames

void setHostNames(String[] names)
                  throws InvalidAttributeValueException

Sets the value of the host name attribute.

Parameters:

names - The new hostName value

Throws:

InvalidAttributeValueException

getUriPrefix

String getUriPrefix()

The URI prefix for this VirtualTarget.

Returns:

the uri prefix.

setUriPrefix

void setUriPrefix(String uriPrefix)
                  throws InvalidAttributeValueException

Set the URI prefix for the partition. The URI prefix must start with "/", otherwise, InvalidAttributeValueException will be thrown.

Parameters:

uriPrefix - the uri prefix.

Throws:

InvalidAttributeValueException

getWebServer

WebServerMBean getWebServer()

The WebServer representing the virtual web server for this VirtualTarget.

Returns:

the web server.

getPortOffset

int getPortOffset()

The port offset for this VirtualTarget. If set to the minimum value, the port offset is not set.

Returns:

the port offset for the partition.

See Also:

VirtualTargetMBean.setPortOffset(int)

setPortOffset

void setPortOffset(int portOffset)
                   throws InvalidAttributeValueException

Set the port offset for the partition. You either set port-offset or configure explicit-port otherwise InvalidAttributeValueException will be thrown. Also, after adding port-offset to port defined in partition reference channel, resulting port should be within the range 1 and 65535 otherwise RuntimeException will be thrown.

Parameters:

portOffset - the port offset added to port defined in partition channel. 0 means port offset is disabled.

Throws:

InvalidAttributeValueException

See Also:

VirtualTargetMBean.setExplicitPort(int)

getExplicitPort

int getExplicitPort()

Get the explicit port for this VirtualTarget.

Returns:

the explicit port for the partition.

See Also:

VirtualTargetMBean.setExplicitPort(int)

setExplicitPort

void setExplicitPort(int explicitPort)
                     throws InvalidAttributeValueException

Set the explicit port for the partition. You either set port-offset or explicit-port otherwise InvalidAttributeValueException will be thrown.

Parameters:

explicitPort - the explicit port. 0 means explicit port is disabled.

Throws:

InvalidAttributeValueException

See Also:

VirtualTargetMBean.setPortOffset(int)

getPartitionChannel

String getPartitionChannel()

The channel name to be used as a reference for a creating partition specific channel.

Returns:

Channel name to be used as a reference for creating a partition specific channel.

See Also:

VirtualTargetMBean.setPartitionChannel(String)

setPartitionChannel

void setPartitionChannel(String partitionChannel)

The channel name to be used as a reference for creating a partition specific channel by applying the port-offset or explicit-port to it. If none is set then the default channel will be used as the base.

In order for this feature to work, the named channel must exist on all targets and must be configured to use the same protocol. It is valid for the selected channel to be configured to use a secure protocol.

Parameters:

partitionChannel - channel name to be used as reference for creating a partition specific channel.

See Also:

VirtualTargetMBean.setPortOffset(int), VirtualTargetMBean.setExplicitPort(int)

getTargets

TargetMBean[] getTargets()

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Specified by:

getTargets in interface DeploymentMBean

Returns:

The targets value

Skip navigation links