public class APIConnectionGroup extends Object
Modifier and Type | Field and Description |
---|---|
static String |
ROOT_IDENTIFIER
The identifier of the root connection group.
|
Constructor and Description |
---|
APIConnectionGroup()
Create an empty APIConnectionGroup.
|
APIConnectionGroup(ConnectionGroup connectionGroup)
Create a new APIConnectionGroup from the given ConnectionGroup record.
|
Modifier and Type | Method and Description |
---|---|
int |
getActiveConnections()
Returns the number of currently active connections using this
connection group.
|
Map<String,String> |
getAttributes()
Returns a map of all attributes associated with this connection group.
|
Collection<APIConnectionGroup> |
getChildConnectionGroups()
Returns a collection of all child connection groups, or null if children
have not been queried.
|
Collection<APIConnection> |
getChildConnections()
Returns a collection of all child connections, or null if children have
not been queried.
|
String |
getIdentifier()
Returns the identifier of this connection group.
|
String |
getName()
Returns the name of this connection group.
|
String |
getParentIdentifier()
Returns the unique identifier for this connection group.
|
ConnectionGroup.Type |
getType()
Returns the type of this connection group.
|
void |
setActiveUsers(int activeConnections)
Set the number of currently active connections using this connection
group.
|
void |
setAttributes(Map<String,String> attributes)
Sets the map of all attributes associated with this connection group.
|
void |
setChildConnectionGroups(Collection<APIConnectionGroup> childConnectionGroups)
Sets the collection of all child connection groups to the given
collection, which may be null if children have not been queried.
|
void |
setChildConnections(Collection<APIConnection> childConnections)
Sets the collection of all child connections to the given collection,
which may be null if children have not been queried.
|
void |
setIdentifier(String identifier)
Set the identifier of this connection group.
|
void |
setName(String name)
Set the name of this connection group.
|
void |
setParentIdentifier(String parentIdentifier)
Sets the parent connection group identifier for this connection group.
|
void |
setType(ConnectionGroup.Type type)
Set the type of this connection group.
|
public static final String ROOT_IDENTIFIER
public APIConnectionGroup()
public APIConnectionGroup(ConnectionGroup connectionGroup)
connectionGroup
- The ConnectionGroup record to initialize this
APIConnectionGroup from.public String getName()
public void setName(String name)
name
- The name of this connection group.public String getIdentifier()
public void setIdentifier(String identifier)
identifier
- The identifier of this connection group.public String getParentIdentifier()
public void setParentIdentifier(String parentIdentifier)
parentIdentifier
- The parent connection group identifier
for this connection group.public ConnectionGroup.Type getType()
public void setType(ConnectionGroup.Type type)
type
- The Type of this connection group.public Collection<APIConnectionGroup> getChildConnectionGroups()
public void setChildConnectionGroups(Collection<APIConnectionGroup> childConnectionGroups)
childConnectionGroups
- The collection containing all child connection groups of this
connection group, or null if children have not been queried.public Collection<APIConnection> getChildConnections()
public void setChildConnections(Collection<APIConnection> childConnections)
childConnections
- The collection containing all child connections of this connection
group, or null if children have not been queried.public int getActiveConnections()
public void setActiveUsers(int activeConnections)
activeConnections
- The number of currently active usages of this connection group.public Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- The attribute map for this connection group.Copyright © 2015. All rights reserved.