| Method | Arguments | Return | Throws Exception |
|---|---|---|---|
| acquireChangeLock | ( ) | % of {acquired, client_id, session_id, lock_time} | YES |
| clearClientQueueById | ( client_id ) | Boolean | YES |
| createClient | ( client_id, client_group, app_name, user_name, authenticator_name [, Aw::ConnectionDescriptor] ) | Boolean | YES |
| createClientGroup | ( client_group_name, life_cycle, storage_type ) | Boolean | YES |
| createSubscriptionById | ( client_id, [ sub | \@subs ] ) | Boolean | YES |
| createTerritory | ( territory_name ) | Boolean | YES |
| createTerritoryGateway | ( territory_name, broker_host, broker_name ) | Boolean | YES |
| destroyBroker | ( ) | Boolean | YES |
| destroyClientById | ( [ client_id | \@client_ids ] ) | Boolean | YES |
| destroyClientGroup | ( [ client_group_name | \@client_group_name ], force_destroy ) | Boolean | YES |
| destroyEventTypeInfoset | ( event_type_name, [ infoset_name | \@infoset_names ] ) | Boolean | YES |
| destroyEventType | ( [ event_type_name | \@event_type_names ], force_destroy ) | Boolean | YES |
| destroySubscriptionById | ( client_id, [ sub | \@subs ] ) | Boolean | YES |
| destroyTerritoryGateway | ( territory_name ) | Boolean | YES |
| disconnectClientById | ( [ client_id | \@client_ids ] ) | Boolean | YES |
| disconnectClientSessionById | ( client_id, session_id ) | Boolean | YES |
| doesSubscriptionExistById | ( client_id, event_type_name, filter ) | Boolean | YES |
| getActivityTraces | ( seqn, msecs ) | % of {seqn, key, tag, ip_address, session_id, session_count, encrypt_level, has_tag, is_authenticated, event_id, dest_client_id, broker_name, broker_host, app_name, client_group, event_type_name} | YES |
| getAllTerritoryGateways | ( ) | @ of % of {gateway_host_name, gateway_broker_name, remote_territory_name, remote_host_name, remote_broker_name, remote_broker_description, auth_type, encrypt_level, is_local, is_complete, num_accessible_territories, accessible_territories} | YES |
| getBrokerDescription | ( ) | String | YES |
| getBrokersInTerritory | ( ) | @ of % of { territory_name, broker_host, broker_name, description} | YES |
| getBrokerStats | ( ) | Aw::Event | YES |
| getClientGroupACL | ( ) | Aw::Admin::AccessControlList | YES |
| getClientGroupCanPublishList | ( client_group_name ) | @ of Strings | YES |
| getClientGroupCanSubscribeList | ( event_type_name ) | @ of Strings | YES |
| getClientGroupInfo | ( [ client_group_name | \@client_group_names ] ) | % (or @ of %) of {name, description, life_cycle, storage_type, required_encryption, access_label_required, is_system_defined} | YES |
| getClientGroupNames | ( ) | @ of Strings | YES |
| getClientGroupStats | ( client_group_name ) | Aw::Event | YES |
| getClientGroupsWhichCanPublish | ( event_type_name ) | @ of Strings | YES |
| getClientGroupsWhichCanSubscribe | ( event_type_name ) | @ of Strings | YES |
| getClientIds | ( ) | @ of Strings | YES |
| getClientIdsByClientGroup | ( client_group_name ) | @ of Strings | YES |
| getClientIdsWhichAreSubscribed | ( event_type_name ) | @ of Strings | YES |
| getClientInfoById | ( [ client_id | \@client_ids [, n] ] ) | % (or @ of %) of {client_id, client_group, app_name, shared_event_ordering, [user_name], [authenticator_name], can_share_state, state_share_limit, access_label, num_sessions, num_access_labels, high_pub_seqn, [sessions]} | YES |
| getClientInfosetById | ( client_id ) | Aw::Event | YES |
| getClientStatsById | ( client_id ) | Aw::Event | YES |
| getClientSubscriptionsById | ( client_id ) | @ of Aw::Subscription | YES |
| getEventAdminTypeDef | ( event_type_name ) | Aw::Admin::TypeDef | YES |
| getEventAdminTypeDefs | ( \@event_type_names ) | @ of Aw::Admin::TypeDef | YES |
| getEventAdminTypeDefsByScope | ( scope_name ) | @ of Aw::Admin::TypeDef | YES |
| getEventTypeStats | ( event_type_name ) | Aw::Event | YES |
| getLocalTerritoryGateways | ( ) | @ of % of {gateway_host_name, gateway_broker_name, remote_territory_name, remote_host_name, remote_broker_name, remote_broker_description, auth_type, encrypt_level, is_local, is_complete, num_accessible_territories, accessible_territories} | YES |
| getTerritoryACL | ( ) | Aw::Admin::AccessControlList | YES |
| getTerritoryGatewayACL | ( ) | Aw::Admin::AccessControlList | YES |
| getTerritoryGatewaySharedEventTypes | ( territory_name ) | @ of % {event_type_name, accept_publish, accept_subscribe, is_synchronized, subscribe_filter} | YES |
| getTerritoryGatewayStats | ( territory_name ) | Aw::Event | YES |
| getTerritoryInfo | ( ) | % of {territory_name, auth_type, encrypt_level} | YES |
| getTerritoryStats | ( ) | Aw::Event | YES |
| joinTerritory | ( broker_host, broker_name ) | % of {client_group_names, num_client_group_names, num_efent_type_names} | YES |
| leaveTerritory | ( msecs, forced ) | Boolean | YES |
| releaseChangeLock | ( ) | Boolean | YES |
| removeBrokerFromTerritory | ( broker_host, broker_name ) | Boolean | YES |
| setBrokerDescription | ( description ) | Boolean | YES |
| setClientGroupAccessLabelRequired | ( client_grou_name, required ) | Boolean | YES |
| setClientGroupRequiredEncryption | ( client_group_name, level ) | Boolean | YES |
| setClientGroupACL | ( client_group_name, Aw::Admin::AccessControlList ) | Boolean | YES |
| setClientGroupDescription | ( client_group_name, description ) | Boolean | YES |
| setClientGroupCanPublishList | ( client_group_name, \@event_type_names ) | Boolean | YES |
| setClientGroupCanSubscribeList | ( client_group_name, \@event_type_names ) | Boolean | YES |
| setClientLastPublishSequenceNumberById | ( client_id, seqn ) | Boolean | YES |
| setClientStatsById | ( client_id, infoset ) | Boolean | YES |
| setClientStateShareLimitById | ( client_id, limit ) | Boolean | YES |
| setEventAdminTypeDef | ( [ type_def | \@type_defs ] ) | Boolean | YES |
| setEventTypeInfoset | ( event_type_name, [infoset_name], [infoset|\@infosets] ) | Boolean | YES |
| setTerritoryACL | ( Aw::Admin::AccessControlList ) | Boolean | YES |
| setTerritoryGatewayACL | ( territory_name, Aw::Admin::AccessControlList ) | Boolean | YES |
| setTerritoryGatewaySecurity | ( territory_name, auth_type, encrypt_level ) | Boolean | YES |
| setTerritoryGatewaySharedEventTypes | ( territory_name, av ) | Boolean | YES |
| setTerritorySecurity | ( auth_type, encrypt_level ) | Boolean | YES |
| Inherited Methods | |||
| Aw::Client | Aw::Admin::Client is derived from Aw::Client. | ||