Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.TopicProxy.Policy

java.lang.Object
        com.ibm.broker.config.proxy.TopicProxy.Policy

public static class TopicProxy.Policy
extends Object

A small class that represents a policy for a given topic.

Constructor Index
Constructor Description
TopicProxy.Policy(String, String, String, String, String) Creates a new Policy object.
Method Index
Method Description
String getPersistence() Returns the persistence value associated with this principal.
TopicProxy.Policy getPolicyFromString(String) Returns a policy object from a String representation
TopicProxy.Policy getPolicyFromString(String, boolean) 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) Sets whether persistence is enabled.
void setPrincipalName(String) Sets the user or group name of the principal.
void setPrincipalType(String) Sets the type of the principal.
void setPublish(String) Sets whether publish is allowed by the policy.
void setSubscribe(String) Sets whether subscribe is allowed by the policy.
String toString() Returns a String representation of the policy.

Constructors

TopicProxy.Policy

public TopicProxy.Policy(String principalName,
                         String principalType,
                         String publish,
                         String subscribe,
                         String persistent) throws ConfigManagerProxyLoggedException

Creates a new Policy object.

Methods

getPersistence

public String getPersistence() 

Returns the persistence value associated with this principal.

getPolicyFromString

public static TopicProxy.Policy getPolicyFromString(String stringEncoded) 

Returns a policy object from a String representation

getPolicyFromString

public static TopicProxy.Policy getPolicyFromString(String stringEncoded,
                                                    boolean principalNameIsEncoded) 

Returns a policy object from a String representation

getPrincipalName

public String getPrincipalName() 

Returns the user or group name associated with this principal

getPrincipalType

public String getPrincipalType() 

Returns the type of the name associated with this principal.

getPublish

public String getPublish() 

Returns the publish value associated with this policy.

getSubscribe

public String getSubscribe() 

Returns the subscribe value associated with this principal.

setPersistence

public void setPersistence(String persistent) throws ConfigManagerProxyLoggedException

Sets whether persistence is enabled.

setPrincipalName

public void setPrincipalName(String principalName) throws ConfigManagerProxyLoggedException

Sets the user or group name of the principal.

setPrincipalType

public void setPrincipalType(String principalType) throws ConfigManagerProxyLoggedException

Sets the type of the principal.

setPublish

public void setPublish(String publish) throws ConfigManagerProxyLoggedException

Sets whether publish is allowed by the policy.

setSubscribe

public void setSubscribe(String subscribe) throws ConfigManagerProxyLoggedException

Sets whether subscribe is allowed by the policy.

toString

public String toString() 

Returns a String representation of the policy. Use getPolicyFromString() to convert this String representation back to a policy.

Class Hierarchy All Classes All Fields and Methods