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
|
// -*- Mode: C++; -*-
// Package : omniORB
// omniURI.h Created on: 2000/04/03
// Author : Duncan Grisby (dpg1)
//
// Copyright (C) 2005-2019 Apasphere Ltd
// Copyright (C) 2000 AT&T Laboratories Cambridge
//
// This file is part of the omniORB library
//
// The omniORB library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library. If not, see http://www.gnu.org/licenses/
//
//
// Description:
// Parsing for object reference URIs
// *** PROPRIETARY INTERFACE ***
//
#ifndef _omniURI_h_
#define _omniURI_h_
#include <omniORB4/CORBA.h>
#include <omniORB4/Naming.hh>
OMNI_NAMESPACE_BEGIN(omni)
class omniURI {
public:
// The omniURI class contains all functions which manipulate object
// URIs, and convert them to-and-from CORBA::Objects.
static char* unescape(const char*& c, unsigned int& size);
// Unescape an escaped path component. Updates c to point to the
// next character after the escaped characters; size is set to the
// size of the unescaped value.
static char* buildURI(const char* prefix,
const char* host,
CORBA::UShort port,
const char* path = 0,
CORBA::Boolean always_port = 1);
// Build a URI with the prefix, containing the host and port,
// properly escaping the host if need be. If path is set, it is
// added to the end, with no escaping. If always_port is false, does
// not include the port if it is zero.
static char* extractHostPort(const char* addr,
CORBA::UShort& port,
const char** rest = 0);
// Extract host and port from the part of a URI containing the
// address. If rest is non-zero, the pointer is set to the address
// of the character following the port number, otherwise anything
// after the port number renders the URI invalid. Returns zero if
// the address is invalid.
static char* extractHostPortRange(const char* addr,
CORBA::UShort& port_min,
CORBA::UShort& port_max);
// Extract host and port range from the part of a URI containing the
// address. Accepts a port range in the form min-max. Returns zero
// if the address is invalid.
static CORBA::Boolean extractURL(const char* url,
char*& scheme,
char*& host,
CORBA::UShort& port,
char*& path,
char*& fragment);
// Extract scheme, host, port, path and fragment from a URL. If no
// port is present in the URL, sets port to zero. path and fragment
// are not unescaped. Returns true if the URL was valid, false if
// not.
static CORBA::Boolean validHostPort(const char* addr);
// True if addr is a valid host:port; false otherwise.
static CORBA::Boolean validHostPortRange(const char* addr);
// True if addr is a valid host:port_min-port_max; false otherwise.
static char* objectToString(CORBA::Object_ptr obj);
// Return a stringified IOR for the given object reference.
// Does not throw any exceptions.
static CORBA::Object_ptr stringToObject(const char* uri,
unsigned int cycles = 0);
// Converts the given URI to an object reference. Currently supports
// IOR:, corbaloc: and corbaname: URIs.
//
// cycles is used to count recursive calls to stringToObject, and
// bail out if we loop too much.
//
// Throws CORBA::MARSHAL and CORBA::BAD_PARAM
static CORBA::Boolean uriSyntaxIsValid(const char* uri);
// Return true if the given URI is syntactically valid, false
// otherwise.
// Does not throw any exceptions.
// URIs are parsed and validated by objects derived from URIHandler
class URIHandler {
public:
virtual CORBA::Boolean supports(const char* uri) = 0;
// Returns true if the handler can parse the URI, false otherwise
// Does not throw any exceptions.
virtual CORBA::Object_ptr toObject(const char* uri,
unsigned int cycles) = 0;
// Convert the given URI to an object reference. If the processing
// involves a (potential) recursive call to stringToObject(),
// cycles should be incremented.
// Throws CORBA system exceptions
virtual CORBA::Boolean syntaxIsValid(const char* uri) = 0;
// Return true if the URI is syntactically valid.
// Does not throw any exceptions.
virtual ~URIHandler();
};
static void registerURIHandler(URIHandler* h);
static void unregisterURIHandler(URIHandler* h);
// Register / unregister a URI handler.
// The following functions implement the stringified name operations
// of CosNaming::NamingContextExt. They are available here to avoid
// the overhead of remote calls just to do some string bashing.
static CosNaming::Name* stringToName(const char* sname);
// Convert a stringified CosNaming::Name into a CosNaming::Name. The
// caller is responsible for freeing it.
static char* nameToString(const CosNaming::Name& name);
// Convert the CosNaming::Name into a stringified name. Throws
// CosNaming::NamingContext::InvalidName if the name sequence has
// zero length.
static char* addrAndNameToURI(const char* addr, const char* sn);
// Convert the given address and stringified name into a corbaname:
// URI. Throws CosNaming::NamingContextExt::InvalidAddress if the
// address syntax is invalid; CosNaming::NamingContext::InvalidName
// if the name syntax is invalid. It does not check if the name
// actually exists in the specified naming service.
};
OMNI_NAMESPACE_END(omni)
#endif // _omniURI_h_
|
