|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.tibco.bpm.web.client.model.pagebus.hub.HubPolicy
public class HubPolicy
Wrapper for a native implementation of the PageBus.policy.HubPolicy interface.
The HubPolicy controls what topics an application loaded from a specified origin can publish or subscribe to. A HubPolicy instance controls each of the following implementations ofHub
:
©2011 Cloud Software Group, Inc.
Nested Class Summary | |
---|---|
static class |
HubPolicy.Operation
Specifies the operation used as parameters by the grant() and revoke() methods. |
Field Summary | |
---|---|
static java.lang.String |
WINDOW_LOCATION
Constant used to indicate the domain URL is the currently loaded window. |
Constructor Summary | |
---|---|
HubPolicy()
Creates an instance using the default native PageBus.policy.HubPolicy. |
|
HubPolicy(com.google.gwt.core.client.JavaScriptObject nativeHubPolicy)
Creates an instance using the provided nativeHubPolicy implementation. |
Method Summary | |
---|---|
void |
applyHubPolicyXml(java.lang.String hubPolicyXml)
Sets the HubPolicy based on the elements in the given hubPolicyXml. |
protected com.google.gwt.core.client.JavaScriptObject |
getNativeHubPolicy()
|
void |
grant(java.lang.String uri,
HubPolicy.Operation opType,
java.lang.String topic)
Grants a privilege to the origin of the given uri. |
boolean |
isPublishAllowed(java.lang.String uri,
java.lang.String topic)
|
boolean |
isSubscribeAllowed(java.lang.String uri,
java.lang.String topic)
|
java.lang.String[] |
listPublishAllowed(java.lang.String uri)
|
java.lang.String[] |
listSubscribeAllowed(java.lang.String uri)
|
static java.lang.String |
originForUri(java.lang.String uri)
Returns the origin for the given uri. |
void |
revoke(java.lang.String uri,
HubPolicy.Operation opType,
java.lang.String topic)
Revokes a privilege from the origin of the given uri. |
void |
revokeAll(java.lang.String uri)
Revokes all privileges from the origin of the given uri. |
void |
revokeHubPolicyXml(java.lang.String hubPolicyXml)
Revokes all privileges that are contained in the given hubPolicyXml regardless of the value of the grant attribute value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String WINDOW_LOCATION
Constructor Detail |
---|
public HubPolicy()
public HubPolicy(com.google.gwt.core.client.JavaScriptObject nativeHubPolicy)
nativeHubPolicy
- Method Detail |
---|
public static java.lang.String originForUri(java.lang.String uri)
uri
- A URI in the form: http://host:port/path/page.html. The URI may be URI encoded.
ManagedHubFrame.getOrigin()
protected com.google.gwt.core.client.JavaScriptObject getNativeHubPolicy()
public void grant(java.lang.String uri, HubPolicy.Operation opType, java.lang.String topic)
uri
- The uri of the application whose origin will be used to grant the privilege.opType
- The Operation type: PUBLISH or SUBSCRIBE.topic
- The topic on which to grant the privilege.public void revoke(java.lang.String uri, HubPolicy.Operation opType, java.lang.String topic)
uri
- The uri of the application whose origin will be used to revoke the privilege.opType
- The Operation type: PUBLISH or SUBSCRIBE.topic
- The topic on which to revoke the privilege.public void revokeAll(java.lang.String uri)
uri
- public void applyHubPolicyXml(java.lang.String hubPolicyXml)
hubPolicyXml
- public void revokeHubPolicyXml(java.lang.String hubPolicyXml)
hubPolicyXml
- public boolean isPublishAllowed(java.lang.String uri, java.lang.String topic)
public boolean isSubscribeAllowed(java.lang.String uri, java.lang.String topic)
public java.lang.String[] listPublishAllowed(java.lang.String uri)
public java.lang.String[] listSubscribeAllowed(java.lang.String uri)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |