ChannelSettings (flex-messaging-common 4.7.0 API)

java.lang.Object
- flex.messaging.config.PropertiesSettings
- - flex.messaging.config.ChannelSettings

```
public class ChannelSettings
extends PropertiesSettings
```
The channel configuration is intentionally generic so that other channels can be added in the future. This format also allows server-endpoint specific and client code-generation specific settings to be modified without affecting needing to update the configuration parser.

Author:

Peter Farland

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`clientContextParsed`
`protected String`	`clientType`
`protected SecurityConstraint`	`constraint`
`protected boolean`	`contextParsed`
`protected String`	`endpointType`
`protected String`	`id`
`protected String`	`parsedClientUri`
`protected String`	`parsedUri`
`protected int`	`port`
`protected boolean`	`remote`
`protected String`	`serverId`
`protected boolean`	`serverOnly`
`protected String`	`uri`

Fields inherited from class flex.messaging.config.PropertiesSettings
properties

Constructor Summary

Constructors
Constructor and Description

ChannelSettings(String id)

Constructors
Constructor and Description
`ChannelSettings(String id)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getClientParsedUri(String contextPath)`
`String`	`getClientType()`
`SecurityConstraint`	`getConstraint()`
`String`	`getEndpointType()`
`String`	`getId()`
`int`	`getPort()` A return value of 0 denotes no port in channel url.
`String`	`getServerId()`
`boolean`	`getServerOnly()`
`String`	`getUri()`
`boolean`	`isRemote()`
`static String`	`parseHost(String url)` Returns the host name in the URL, or an empty `String` if the URL does not contain a host name.
`static int`	`parsePort(String url)` Returns the port number specified in the URL, or 0 if the URL does not contain a port number, or -1 if the URL contains a server.port token.
`static String`	`removeTokens(String url)` Remove protocol, host, port and context-root from a given url.
`void`	`setClientType(String type)`
`void`	`setConstraint(SecurityConstraint constraint)`
`void`	`setEndpointType(String type)`
`void`	`setRemote(boolean value)`
`void`	`setServerId(String value)`
`void`	`setServerOnly(boolean serverOnly)`
`void`	`setUri(String uri)`

Methods inherited from class flex.messaging.config.PropertiesSettings
addProperties, addProperty, addProperty, getProperties, getProperty, getPropertyAsBoolean, getPropertyAsInt, getPropertyAsList, getPropertyAsLong, getPropertyAsMap, getPropertyAsString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
  - remote
```
protected boolean remote
```
  - serverId
```
protected String serverId
```
  - constraint
```
protected SecurityConstraint constraint
```
  - uri
```
protected String uri
```
  - port
```
protected int port
```
  - endpointType
```
protected String endpointType
```
  - clientType
```
protected String clientType
```
  - serverOnly
```
protected boolean serverOnly
```
  - parsedUri
```
protected String parsedUri
```
  - contextParsed
```
protected boolean contextParsed
```
  - parsedClientUri
```
protected String parsedClientUri
```
  - clientContextParsed
```
protected boolean clientContextParsed
```
- Constructor Detail
  - ChannelSettings
```
public ChannelSettings(String id)
```
- Method Detail
  - getId
```
public String getId()
```
  - isRemote
```
public boolean isRemote()
```
  - setRemote
```
public void setRemote(boolean value)
```
  - getServerId
```
public String getServerId()
```
  - setServerId
```
public void setServerId(String value)
```
  - getClientType
```
public String getClientType()
```
  - setClientType
```
public void setClientType(String type)
```
  - getServerOnly
```
public boolean getServerOnly()
```
  - setServerOnly
```
public void setServerOnly(boolean serverOnly)
```
  - getPort
```
public int getPort()
```
    A return value of 0 denotes no port in channel url.
    
    Returns:
    the port number for this channel or 0 if channel url does not contain a port number
  - getUri
```
public String getUri()
```
  - setUri
```
public void setUri(String uri)
```
  - getClientParsedUri
```
public String getClientParsedUri(String contextPath)
```
  - getEndpointType
```
public String getEndpointType()
```
  - setEndpointType
```
public void setEndpointType(String type)
```
  - getConstraint
```
public SecurityConstraint getConstraint()
```
  - setConstraint
```
public void setConstraint(SecurityConstraint constraint)
```
  - parseHost
```
public static String parseHost(String url)
```
    Returns the host name in the URL, or an empty String if the URL does not contain a host name.
    
    Parameters:
    url - The URL to parse for a host name.
    
    Returns:
    The host name or an empty String if the URL does not contain a host name.
  - parsePort
```
public static int parsePort(String url)
```
    Returns the port number specified in the URL, or 0 if the URL does not contain a port number, or -1 if the URL contains a server.port token.
    
    Parameters:
    url - The URL to parse for a contained port number.
    
    Returns:
    the port number in the URL, or 0 if the URL does not contain a port number, or -1 if the URL contains a server.port token.
  - removeTokens
```
public static String removeTokens(String url)
```
    Remove protocol, host, port and context-root from a given url. Unlike parseClientUri, this method does not check if the channel setting has been parsed before.
    
    Parameters:
    url - Original url.
    
    Returns:
    Url with protocol, host, port and context-root removed.

Class ChannelSettings

Field Summary

Fields inherited from class flex.messaging.config.PropertiesSettings

Constructor Summary

Method Summary

Methods inherited from class flex.messaging.config.PropertiesSettings

Methods inherited from class java.lang.Object

Field Detail

id

remote

serverId

constraint

uri

port

endpointType

clientType

serverOnly

parsedUri

contextParsed

parsedClientUri

clientContextParsed

Constructor Detail

ChannelSettings

Method Detail

getId

isRemote

setRemote

getServerId

setServerId

getClientType

setClientType

getServerOnly

setServerOnly

getPort

getUri

setUri

getClientParsedUri

getEndpointType

setEndpointType

getConstraint

setConstraint

parseHost

parsePort

removeTokens