|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.broker.config.proxy.TopicProxy.Policy
A small class that represents a policy for a given topic.
Constructor Summary | |
---|---|
TopicProxy.Policy(String principalName,
String principalType,
String publish,
String subscribe,
String persistent)
Creates a new Policy object. |
Method Summary | |
---|---|
String |
getPersistence()
Returns the persistence value associated with this principal. |
static TopicProxy.Policy |
getPolicyFromString(String stringEncoded)
Returns a policy object from a String representation |
static TopicProxy.Policy |
getPolicyFromString(String stringEncoded,
boolean principalNameIsEncoded)
Returns a policy object from a String representation |
String |
getPrincipalName()
Returns the user or group name associated with this principal |
String |
getPrincipalType()
Returns the type of the name associated with this principal. |
String |
getPublish()
Returns the publish value associated with this policy. |
String |
getSubscribe()
Returns the subscribe value associated with this principal. |
void |
setPersistence(String persistent)
Sets whether persistence is enabled. |
void |
setPrincipalName(String principalName)
Sets the user or group name of the principal. |
void |
setPrincipalType(String principalType)
Sets the type of the principal. |
void |
setPublish(String publish)
Sets whether publish is allowed by the policy. |
void |
setSubscribe(String subscribe)
Sets whether subscribe is allowed by the policy. |
String |
toString()
Returns a String representation of the policy. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TopicProxy.Policy(String principalName, String principalType, String publish, String subscribe, String persistent) throws ConfigManagerProxyLoggedException
principalName
- Name of the user or group
to which this policy refers (e.g. "fred")principalType
- Denotes the type of the
policy. Valid values:
publish
- Denotes whether the principal allows
publish requests. Valid values:
subscribe
- Denotes whether the policy allows
subscribe requests. Valid values:
persistent
- Denotes whether persistence is enabled.
ConfigManagerProxyLoggedException
- if any of the values
supplied to this constructor were invalid.Method Detail |
public void setPrincipalName(String principalName) throws ConfigManagerProxyLoggedException
principalName
- Name of the user or group
to which this principal refers (e.g. "fred")
ConfigManagerProxyLoggedException
- if the value
supplied was invalid.public void setPrincipalType(String principalType) throws ConfigManagerProxyLoggedException
principalType
- Denotes the type of the
principal. Valid values:
ConfigManagerProxyLoggedException
- if the value
supplied was invalid.public void setPublish(String publish) throws ConfigManagerProxyLoggedException
publish
- Denotes whether the policy allows
publish requests. Valid values:
ConfigManagerProxyLoggedException
- if the value
supplied was invalid.public void setSubscribe(String subscribe) throws ConfigManagerProxyLoggedException
subscribe
- Denotes whether the principal allows
subscribe requests. Valid values:
ConfigManagerProxyLoggedException
- if the value
supplied was invalid.public void setPersistence(String persistent) throws ConfigManagerProxyLoggedException
persistent
- Denotes whether persistence is enabled.
ConfigManagerProxyLoggedException
- if the value
supplied was invalid.public String getPrincipalName()
public String getPrincipalType()
public String getPublish()
public String getSubscribe()
public String getPersistence()
public static TopicProxy.Policy getPolicyFromString(String stringEncoded)
stringEncoded
- String representation of
the Principal, (as returned by Policy.toString()).
The name of the principal will be URI encoded.
public static TopicProxy.Policy getPolicyFromString(String stringEncoded, boolean principalNameIsEncoded)
stringEncoded
- String representation of
the Principal, (as returned by Policy.toString()).principalNameIsEncoded
- True if and only if
the name of the principal is known to be URI-encoded.
public String toString()
|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |