/
Constants.ice
297 lines (253 loc) · 10.1 KB
/
Constants.ice
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/*
* $Id$
*
* Copyright 2007 Glencoe Software, Inc. All rights reserved.
* Use is subject to license terms supplied in LICENSE.txt
*
*/
#ifndef OMERO_CONSTANTS_ICE
#define OMERO_CONSTANTS_ICE
module omero {
/**
* Most client-intended constants are provided in this module.
**/
module constants {
/**
* Key in the ImplicitContext which must be filled
* by all omero.client implementations. Primarily
* used by the session manager to count references
* to sessions.
**/
const string CLIENTUUID = "omero.client.uuid";
/**
* Key in the ImplicitContext which must be filled
* by all omero.client implementations. Primarily
* used by backend services to lookup the proper
* sessions for clients.
**/
const string SESSIONUUID = "omero.session.uuid";
/**
* Default Ice.GC.Interval for OmeroCpp (60 seconds)
**/
const int GCINTERVAL = 60;
/**
* Default Glacier2 port. Used to define '@omero.port@' if not set.
**/
const int GLACIER2PORT = 4064;
/**
* Default Ice.MessageSizeMax (65536kb). Not strictly necessary, but helps to
* curb memory issues. Must be set before communicator initialization.
**/
const int MESSAGESIZEMAX = 65536;
/**
* Determines the batch size for sending
* objects to the server. Too many can
* result in MessageSizeMax errors.
**/
const int DEFAULTBATCHSIZE = 2000;
/**
* Default size for byte arrays during upload and download
* of binary data.
**/
const int DEFAULTBLOCKSIZE = 5000000;
/**
* Default omero.ClientCallback.ThreadPool.Size (5).
* Must be set before communicator initialization.
**/
const int CLIENTTHREADPOOLSIZE = 5;
/**
* Default Ice.Override.ConnectTimeout (5000). Also not strictly necessary,
* but prevents clients being blocked by failed servers. -1 disables.
**/
const int CONNECTTIMEOUT = 5000;
/**
* Default connection string for connecting to Glacier2
* (Ice.Default.Router). The '@omero.port@' and '@omero.host@' values will
* be replaced by the properties with those names from the context.
**/
const string DEFAULTROUTER = "OMERO.Glacier2/router:ssl -p @omero.port@ -h @omero.host@";
/**
* Server-side names used for each of the services
* defined in API.ice. These names can be used in
* the ServiceFactory.getByName() and createByName()
* methods.
**/
const string ADMINSERVICE = "omero.api.IAdmin";
const string ANALYSISSERVICE = "omero.api.IAnalysis";
const string CONFIGSERVICE = "omero.api.IConfig";
const string CONTAINERSERVICE = "omero.api.IContainer";
const string EXPORTERSERVICE = "omero.api.Exporter";
const string LDAPSERVICE = "omero.api.ILdap";
const string PIXELSSERVICE = "omero.api.IPixels";
const string PROJECTIONSERVICE= "omero.api.IProjection";
const string QUERYSERVICE = "omero.api.IQuery";
const string SESSIONSERVICE = "omero.api.ISession";
const string SHARESERVICE = "omero.api.IShare";
const string TIMELINESERVICE = "omero.api.ITimeline";
const string TYPESSERVICE = "omero.api.ITypes";
const string UPDATESERVICE = "omero.api.IUpdate";
const string JOBHANDLE = "omero.api.JobHandle";
const string RAWFILESTORE = "omero.api.RawFileStore";
const string RAWPIXELSSTORE = "omero.api.RawPixelsStore";
const string RENDERINGENGINE = "omero.api.RenderingEngine";
const string ROISERVICE = "omero.api.IRoi";
const string SCRIPTSERVICE = "omero.api.IScript";
const string SEARCH = "omero.api.Search";
const string THUMBNAILSTORE = "omero.api.ThumbnailStore";
const string REPOSITORYINFO = "omero.api.IRepositoryInfo";
const string RENDERINGSETTINGS= "omero.api.IRenderingSettings";
const string METADATASERVICE = "omero.api.IMetadata";
const string SHAREDRESOURCES = "omero.grid.SharedResources";
// User context for logging in
const string USERNAME = "omero.user";
const string PASSWORD = "omero.pass";
const string GROUP = "omero.group";
const string EVENT = "omero.event";
const string AGENT = "omero.agent";
const string IP = "omero.ip";
module cluster {
// config string used by the ConfigRedirector
const string REDIRECT = "omero.cluster.redirect";
};
/**
* General constants used for annotations.
**/
module annotation {
/** Constants used for file annotations. **/
module file {
const string ORIGINALMETADATAPREFIX = "/openmicroscopy.org/omero/image_files/";
const string ORIGINALMETADATA = "original_metadata.txt";
};
};
/**
* Constants used for field defaults and similar
* in the [omero::model::] classes.
**/
module data {
/**
* Set as Image.name when no name is provided by the user.
**/
const string NONAMESET = "NO_NAME_SET";
};
/**
* Namespaces for the [omero::api::IMetadata] interface.
**/
module metadata {
const string NSINSIGHTTAGSET = "openmicroscopy.org/omero/insight/tagset";
const string NSINSIGHTRATING = "openmicroscopy.org/omero/insight/rating";
const string NSMOVIE = "openmicroscopy.org/omero/movie";
const string NSCLIENTMAPANNOTATION = "openmicroscopy.org/omero/client/mapAnnotation";
};
/**
* General namespaces for <a href="http://www.openmicroscopy.org/site/support/omero5.2/developers/Modules/StructuredAnnotations.html">StructuredAnnotations</a>
**/
module namespaces {
const string NSFSRENAME = "openmicroscopy.org/omero/fs/rename";
const string NSMEASUREMENT = "openmicroscopy.org/omero/measurement";
const string NSAUTOCLOSE = "openmicroscopy.org/omero/import/autoClose";
const string NSCOMPANIONFILE = "openmicroscopy.org/omero/import/companionFile";
const string NSLOGFILE = "openmicroscopy.org/omero/import/logFile";
const string NSFILETRANSFER = "openmicroscopy.org/omero/import/fileTransfer";
const string NSEXPERIMENTERPHOTO = "openmicroscopy.org/omero/experimenter/photo";
const string NSBULKANNOTATIONS = "openmicroscopy.org/omero/bulk_annotations";
const string NSOMETIFF = "openmicroscopy.org/omero/ome_tiff";
//
// omero.grid.Param.namespaces in Scripts.ice
//
const string NSCREATED = "openmicroscopy.org/omero/scripts/results/created";
const string NSDOWNLOAD = "openmicroscopy.org/omero/scripts/results/download";
const string NSVIEW = "openmicroscopy.org/omero/scripts/results/view";
//
// omero.grid.JobParam.namespaces in Scripts.ice
//
const string NSDYNAMIC = "openmicroscopy.org/omero/scripts/job/dynamic";
//
// modulo namespaces for <a href="http://www.openmicroscopy.org/site/support/ome-model/developers/6d-7d-and-8d-storage.html">6d-7d-and-8d-storage</a>
//
const string NSMODULO = "openmicroscopy.org/omero/dimension/modulo";
};
/**
* Namespaces for analysis.
**/
module analysis {
/** namespaces related to the FLIM analysis. **/
module flim {
const string NSFLIM = "openmicroscopy.org/omero/analysis/flim";
//keywords associated to the namespace.
const string KEYWORDFLIMCELL = "Cell";
const string KEYWORDFLIMBACKGROUND = "Background";
};
};
module jobs {
/**
* Used by JobHandle as the status of jobs
**/
const string SUBMITTED = "Submitted";
const string RESUBMITTED = "Resubmitted";
const string QUEUED = "Queued";
const string REQUEUED = "Requeued";
const string RUNNING = "Running";
const string ERRORX = "Error"; // Can't be 'ERROR' or C++ won't compile
const string WAITING = "Waiting";
const string FINISHED = "Finished";
const string CANCELLED = "Cancelled";
};
module permissions {
/**
* Index into the [omero::model::Permissions::restrictions]
* [omero::api::BoolArray] field to test whether or not
* the link restriction has been applied to the current object.
**/
const int LINKRESTRICTION = 0;
/**
* Index into the [omero::model::Permissions::restrictions]
* [omero::api::BoolArray] field to test whether or not
* the edit restriction has been applied to the current object.
**/
const int EDITRESTRICTION = 1;
/**
* Index into the [omero::model::Permissions::restrictions]
* [omero::api::BoolArray] field to test whether or not
* the delete restriction has been applied to the current object.
**/
const int DELETERESTRICTION = 2;
/**
* Index into the [omero::model::Permissions::restrictions]
* [omero::api::BoolArray] field to test whether or not
* the annotate restriction has been applied to the current object.
**/
const int ANNOTATERESTRICTION = 3;
/**
* Extended restriction name which may be applied to images and other
* downloadable materials. This string can also be found in the
* ome.security.policy.BinaryAccessPolicy class.
**/
const string BINARYACCESS = "RESTRICT-BINARY-ACCESS";
};
module projection {
/**
* Methodology strings
**/
const string MAXIMUMINTENSITYMETHODOLOGY = "MAXIMUM_INTENSITY_PROJECTION";
const string MEANINTENSITYMETHODOLOGY = "MEAN_INTENSITY_PROJECTION";
const string SUMINTENSITYMETHODOLOGY = "SUM_INTENSITY_PROJECTION";
/**
* Used by the IProjection methods to declare which projection to perform.
**/
enum ProjectionType {
MAXIMUMINTENSITY,
MEANINTENSITY,
SUMINTENSITY
};
};
module topics {
const string PROCESSORACCEPTS = "/internal/ProcessorAccept";
const string HEARTBEAT = "/public/HeartBeat";
};
module categories {
const string PROCESSORCALLBACK = "ProcessorCallback";
const string PROCESSCALLBACK = "ProcessCallback";
};
};
};
#endif