public interface

WebChannel

com.microstrategy.web.objects.WebChannel

Class Overview

The WebChannel interface represents a communciation channel defined in a WebServerDef object. This interface allows the user to view and modify the settings of a channel. WebChannel objects can only be obtained from a WebChannels collection.

Summary

Public Methods
abstract int getMaximumConnections()
Returns the maximum connections set on this channel.
abstract String getName()
Returns the name of the channel.
abstract int getType()
Returns the type of the channel.This is a value from EnumDSSXMLChannelType
abstract void setMaximumConnections(int maxConnections)
This method can be used to change the maximum number of connections set on the channel.

Public Methods

public abstract int getMaximumConnections ()

Returns the maximum connections set on this channel.

Returns
  • The current setting for maximum connections on the channel.

public abstract String getName ()

Returns the name of the channel.

Returns
  • The name of the channel.

public abstract int getType ()

Returns the type of the channel.This is a value from EnumDSSXMLChannelType

Returns
  • The type of the channel.

public abstract void setMaximumConnections (int maxConnections)

This method can be used to change the maximum number of connections set on the channel.

Parameters
maxConnections The new value for the maximum number of connections.