Aw::Admin::Client

MethodArgumentsReturnThrows
Exception
acquireChangeLock( )% of {acquired, client_id, session_id, lock_time}YES
clearClientQueueById( client_id )BooleanYES
createClient( client_id, client_group, app_name, user_name, authenticator_name [, Aw::ConnectionDescriptor] )BooleanYES
createClientGroup( client_group_name, life_cycle, storage_type )BooleanYES
createSubscriptionById( client_id, [ sub | \@subs ] )BooleanYES
createTerritory( territory_name )BooleanYES
createTerritoryGateway( territory_name, broker_host, broker_name )BooleanYES
destroyBroker( )BooleanYES
destroyClientById( [ client_id | \@client_ids ] )BooleanYES
destroyClientGroup( [ client_group_name | \@client_group_name ], force_destroy )BooleanYES
destroyEventTypeInfoset( event_type_name, [ infoset_name | \@infoset_names ] )BooleanYES
destroyEventType( [ event_type_name | \@event_type_names ], force_destroy )BooleanYES
destroySubscriptionById( client_id, [ sub | \@subs ] )BooleanYES
destroyTerritoryGateway( territory_name )BooleanYES
disconnectClientById( [ client_id | \@client_ids ] )BooleanYES
disconnectClientSessionById( client_id, session_id )BooleanYES
doesSubscriptionExistById( client_id, event_type_name, filter )BooleanYES
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( )StringYES
getBrokersInTerritory( )@ of % of {
territory_name,
broker_host,
broker_name,
description}
YES
getBrokerStats( )Aw::EventYES
getClientGroupACL( )Aw::Admin::AccessControlListYES
getClientGroupCanPublishList( client_group_name )@ of StringsYES
getClientGroupCanSubscribeList( event_type_name )@ of StringsYES
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 StringsYES
getClientGroupStats( client_group_name )Aw::EventYES
getClientGroupsWhichCanPublish( event_type_name )@ of StringsYES
getClientGroupsWhichCanSubscribe( event_type_name )@ of StringsYES
getClientIds( )@ of StringsYES
getClientIdsByClientGroup( client_group_name )@ of StringsYES
getClientIdsWhichAreSubscribed( event_type_name )@ of StringsYES
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::EventYES
getClientStatsById( client_id )Aw::EventYES
getClientSubscriptionsById( client_id )@ of Aw::SubscriptionYES
getEventAdminTypeDef( event_type_name )Aw::Admin::TypeDefYES
getEventAdminTypeDefs( \@event_type_names )@ of Aw::Admin::TypeDefYES
getEventAdminTypeDefsByScope( scope_name )@ of Aw::Admin::TypeDefYES
getEventTypeStats( event_type_name )Aw::EventYES
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::AccessControlListYES
getTerritoryGatewayACL( )Aw::Admin::AccessControlListYES
getTerritoryGatewaySharedEventTypes( territory_name )@ of % {event_type_name,
accept_publish,
accept_subscribe,
is_synchronized,
subscribe_filter}
YES
getTerritoryGatewayStats( territory_name )Aw::EventYES
getTerritoryInfo( )% of {territory_name,
auth_type,
encrypt_level}
YES
getTerritoryStats( )Aw::EventYES
joinTerritory( broker_host, broker_name )% of {client_group_names,
num_client_group_names,
num_efent_type_names}
YES
leaveTerritory( msecs, forced )BooleanYES
releaseChangeLock( )BooleanYES
removeBrokerFromTerritory( broker_host, broker_name )BooleanYES
setBrokerDescription( description )BooleanYES
setClientGroupAccessLabelRequired( client_grou_name, required )BooleanYES
setClientGroupRequiredEncryption( client_group_name, level )BooleanYES
setClientGroupACL( client_group_name, Aw::Admin::AccessControlList )BooleanYES
setClientGroupDescription( client_group_name, description )BooleanYES
setClientGroupCanPublishList( client_group_name, \@event_type_names )BooleanYES
setClientGroupCanSubscribeList( client_group_name, \@event_type_names )BooleanYES
setClientLastPublishSequenceNumberById( client_id, seqn )BooleanYES
setClientStatsById( client_id, infoset )BooleanYES
setClientStateShareLimitById( client_id, limit )BooleanYES
setEventAdminTypeDef( [ type_def | \@type_defs ] )BooleanYES
setEventTypeInfoset( event_type_name, [infoset_name], [infoset|\@infosets] )BooleanYES
setTerritoryACL( Aw::Admin::AccessControlList )BooleanYES
setTerritoryGatewayACL( territory_name, Aw::Admin::AccessControlList )BooleanYES
setTerritoryGatewaySecurity( territory_name, auth_type, encrypt_level )BooleanYES
setTerritoryGatewaySharedEventTypes( territory_name, av )BooleanYES
setTerritorySecurity( auth_type, encrypt_level )BooleanYES
Inherited Methods
Aw::ClientAw::Admin::Client is derived from Aw::Client.