Ice 3.7 Slice API Reference
All Classes Interfaces Structs Exceptions Modules Files Operations Constants Sequences Dictionaries Enumerations Enumerator Pages
Session.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:GLACIER2_API"]]
8 [["cpp:doxygen:include:Glacier2/Glacier2.h"]]
9 [["cpp:header-ext:h"]]
10 [["cpp:include:Glacier2/Config.h"]]
11 
12 [["js:module:ice"]]
13 [["js:cjs-module"]]
14 
15 [["objc:dll-export:GLACIER2_API"]]
16 [["objc:header-dir:objc"]]
17 
18 [["python:pkgdir:Glacier2"]]
19 
20 #include <Ice/BuiltinSequences.ice>
21 #include <Ice/Identity.ice>
22 #include <Glacier2/SSLInfo.ice>
23 
24 #ifndef __SLICE2JAVA_COMPAT__
25 [["java:package:com.zeroc"]]
26 #endif
27 
28 ["objc:prefix:GLACIER2"]
29 module Glacier2
30 {
31 
37 ["preserve-slice"]
39 {
45  string reason;
46 }
47 
56 interface Session
57 {
63  void destroy();
64 }
65 
76 interface StringSet
77 {
86  idempotent void add(Ice::StringSeq additions);
87 
96  idempotent void remove(Ice::StringSeq deletions);
97 
106  idempotent Ice::StringSeq get();
107 }
108 
118 interface IdentitySet
119 {
128  idempotent void add(Ice::IdentitySeq additions);
129 
138  idempotent void remove(Ice::IdentitySeq deletions);
139 
148  idempotent Ice::IdentitySeq get();
149 }
150 
159 interface SessionControl
160 {
170 
180 
190 
198  idempotent int getSessionTimeout();
199 
205  void destroy();
206 }
207 
220 interface SessionManager
221 {
236  ["format:sliced"]
237  Session* create(string userId, SessionControl* control)
239 }
240 
254 {
269  ["format:sliced"]
272 }
273 
274 }
Glacier2::Session::destroy
void destroy()
Destroy the session.
Glacier2::SessionControl::adapterIds
StringSet * adapterIds()
Access the object that manages the allowable adapter identities for objects for this session.
BuiltinSequences.ice
SSLInfo.ice
Glacier2::SessionControl::categories
StringSet * categories()
Access the object that manages the allowable categories for object identities for this session.
Glacier2::SSLSessionManager::create
Session * create(SSLInfo info, SessionControl *control)
Create a new session.
Ice::StringSeq
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
Glacier2::SSLInfo
Information taken from an SSL connection used for permissions verification.
Definition: SSLInfo.ice:39
Glacier2::CannotCreateSessionException
This exception is raised if an attempt to create a new session failed.
Definition: Session.ice:39
Glacier2::StringSet::add
idempotent void add(Ice::StringSeq additions)
Add a sequence of strings to this set of constraints.
Glacier2::IdentitySet::add
idempotent void add(Ice::IdentitySeq additions)
Add a sequence of Ice identities to this set of constraints.
Glacier2::StringSet
An object for managing the set of identity constraints for specific parts of object identity on a Ses...
Definition: Session.ice:77
Glacier2::SessionManager
The session manager for username/password authenticated users that is responsible for managing Sessio...
Definition: Session.ice:221
Glacier2
Glacier2 is a firewall solution for Ice.
Definition: PermissionsVerifier.ice:28
Glacier2::SSLSessionManager
The session manager for SSL authenticated users that is responsible for managing Session objects.
Definition: Session.ice:254
Glacier2::SessionControl::identities
IdentitySet * identities()
Access the object that manages the allowable object identities for this session.
Glacier2::SessionControl::getSessionTimeout
idempotent int getSessionTimeout()
Get the session timeout.
Glacier2::Session
A client-visible session object, which is tied to the lifecycle of a Router.
Definition: Session.ice:57
Identity.ice
Glacier2::SessionManager::create
Session * create(string userId, SessionControl *control)
Create a new session.
Glacier2::SessionControl
An administrative session control object, which is tied to the lifecycle of a Session.
Definition: Session.ice:160
Ice::IdentitySeq
sequence< Identity > IdentitySeq
A sequence of identities.
Definition: Identity.ice:73
Glacier2::IdentitySet
An object for managing the set of object identity constraints on a Session.
Definition: Session.ice:119
Glacier2::SessionControl::destroy
void destroy()
Destroy the associated session.
Glacier2::CannotCreateSessionException::reason
string reason
The reason why session creation has failed.
Definition: Session.ice:45