summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/ImplRepo_Service/ImplRepo_i.h
blob: 009ec7aeb52b2a60153971886a6b1207fbf85d38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    TAO/orbsvcs/ImplRepo_Service
//
// = FILENAME
//    ImplRepo_i.h
//
// = DESCRIPTION
//    This class implements the Implementation Repository.
//
// = AUTHOR
//    Darrell Brunsch <brunsch@cs.wustl.edu>
//
// ============================================================================

#ifndef IMPLREPO_I_H
#define IMPLREPO_I_H

#include "orbsvcs/ImplRepoS.h"
#include "Repository.h"
#include "tao/TAO.h"

// Forward declarations.
class ImplRepo_i;
class IR_Forwarder;

// Typedefs.
typedef ImplRepo_i *ImplRepo_i_ptr;
typedef ImplRepo_i_ptr ImplRepo_i_ref;

class IR_Adapter_Activator : public POA_PortableServer::AdapterActivator
{
  // = TITLE
  //    Implementation Repository Adapter Activator
  //
  // = DESCRIPTION
  //    Part of the Default Servant/DSI combination that forwards
  //    arbitrary requests.  This allows for the setting up of child
  //    POAs with default servants.
public:
  IR_Adapter_Activator (IR_Forwarder *servant,
                        PortableServer::POAManager_ptr poa_manager);
  // Constructor

  virtual CORBA::Boolean unknown_adapter (PortableServer::POA_ptr parent,
                                          const char *name,
                                          CORBA_Environment &ACE_TRY_ENV
                                            = TAO_default_environment ());
  // Called by the POA when the incoming requested object/POA isn't found.  This will
  // create POAs when needed and will also put a DSI object (IR_Forwarder) in that POA
  // as a default servant to handle that request
private:
  IR_Forwarder *servant_;
  // The object to use as the default servant.

  PortableServer::POAManager_var poa_manager_;
  // POA Manager
};

class ImplRepo_i : public POA_ImplementationRepository::Administration
{
  // = TITLE
  //    Implementation Repository
  //
  // = DESCRIPTION
  //    This provides the interface to Administer the Implementation Repository.
public:
  // = Constructor and destructor
  ImplRepo_i (void);
  ~ImplRepo_i (void);

  // = Interface methods

  virtual void activate_server (const char * server,
                                CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound,
                     ImplementationRepository::Administration::CannotActivate));
  // Starts up the server <server> if not already running.

  virtual void register_server (const char *server,
                                const ImplementationRepository::StartupOptions &options,
                                CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::AlreadyRegistered));
  // Adds the server to the repository and registers the startup information about 
  // the server <server>.

  virtual void reregister_server (const char *server,
                                  const ImplementationRepository::StartupOptions &options,
                                  CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException));
  // Updates the startup information about the server <server>.

  virtual void remove_server (const char *server,
                              CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound));
  // Removes the server <server> from the repository.

  virtual void shutdown_server (const char * server,
                                CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound));
  // Attempts to gracefully shut down the server, if that fails, will try
  // to do it ungracefully.
  
  virtual ImplementationRepository::Address * 
    server_is_running (const char * server,
                       const ImplementationRepository::Address &addr,
                       ImplementationRepository::ServerObject_ptr server_object,
                       CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound));
  // Called by the server to update transient information such as current location of
  // the <server> and its ServerObject.

  virtual void server_is_shutting_down (const char * server,
                                        CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound));
  // What the server should call before it shuts down.

  virtual void find (const char * server,
                     ImplementationRepository::ServerInformation_out info,
                     CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException,
                     ImplementationRepository::Administration::NotFound));
  // Returns the startup information for a server

  virtual void list (CORBA::ULong how_many,
                     ImplementationRepository::ServerInformationList_out server_list,
                     ImplementationRepository::ServerInformationIterator_out server_iterator,
                     CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException));
  // Used to access the list of servers registered.  May also return an
  // iterator which can be used to access more than <how_many> of them.

  // = Other methods

  int init (int argc, char **argv, 
            CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ());
  // Initialize the Server state - parsing arguments and waiting.

  int run (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ());
  // Runs the orb.

  CORBA::String get_forward_host (const char *server);
  // Returns the host of the server that needs to be forwarded to.

  CORBA::UShort get_forward_port (const char *server);
  // Returns the port of the server that needs to be forwarded to.

private:
  IR_Forwarder *forwarder_impl_;
  // The class that handles the forwarding.

  IR_Adapter_Activator *activator_;
  // Used for the forwarding of any type of POA.

  Server_Repository repository_;
  // Repository containing information about each server.

  TAO_ORB_Manager orb_manager_;
  // The ORB manager.

  char *server_key_;
  // Key of the obj ref of the server.

  char *server_input_file_;
  // Copy of the filename for the server output file.

  int argc_;
  // Number of command line arguments.

  char **argv_;
  // The command line arguments.
};

class IR_Forwarder: public PortableServer::DynamicImplementation
  // = TITLE
  //    Implementation Repository Forwarder
  //
  // = DESCRIPTION
  //    This class is provides a DSI implementation that is used to handle
  //    arbitrary calls and forward them to the correct place.
{
public:
  IR_Forwarder (CORBA::ORB_ptr orb_ptr,
                PortableServer::POA_ptr poa_ptr,
                ImplRepo_i *ir_impl);
  // Constructor

  virtual void invoke (CORBA::ServerRequest_ptr request,
                       CORBA::Environment &env);
  // The invoke() method receives requests issued to any CORBA
  // object incarnated by the DSI servant and performs the
  // processing necessary to execute the request.

  CORBA::RepositoryId _primary_interface (const PortableServer::ObjectId &oid,
                                          PortableServer::POA_ptr poa,
                                          CORBA::Environment &env = TAO_default_environment ());
  // DynamicImplementation stuff

private:
  class ImplRepo_i *ir_impl_;
  // Where we find out where to forward to.

  CORBA::ORB_var orb_var_;
  // ORB reference.

  PortableServer::POA_var poa_var_;
  // POA reference.
};

class IR_Iterator : public POA_ImplementationRepository::ServerInformationIterator
{
public:
  IR_Iterator (Server_Repository::HASH_IR_ITER *iterator,
               PortableServer::POA_ptr poa);
  // Constructor
  // Ownership of iterator is transfered to this class (we'll delete it)

  ~IR_Iterator ();
  // Destructor

  virtual CORBA::Boolean next_n (CORBA::ULong how_many,
                                 ImplementationRepository::ServerInformationList_out server_list,
                                 CORBA::Environment &ACE_TRY_ENV = CORBA::Environment::default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
  // Returns the next list of up to <how_many> servers.  If empty, will return
  // false.

  virtual void destroy (CORBA::Environment &ACE_TRY_ENV = CORBA::Environment::default_environment ())
    ACE_THROW_SPEC ((CORBA::SystemException));
  // Destroys the iterator.

private:
  Server_Repository::HASH_IR_ITER *iterator_;
  // Our very own iterator for transversing the server repository.

  PortableServer::POA_var poa_;
  // Our lovely POA.
};

#endif /* IMPLREPO_I_H */