Source code: com/flexstor/common/constants/ActionPropertiesI.java
1 /*
2 * ActionPropertiesI.java
3 *
4 * Copyright $Date: 2003/08/11 02:22:32 $ FLEXSTOR.net Inc.
5 *
6 * This work is licensed for use and distribution under license terms found at
7 * http://www.flexstor.org/license.html
8 *
9 */
10
11 package com.flexstor.common.constants;
12
13 /**
14 * Constants for properties defined in ActionData and RecordData
15 */
16 public interface ActionPropertiesI
17 {
18 // Global Properties
19 /** User Id for current user */
20 public final static String USER_ID = "User_Id"; // String
21 /** During a resource fork service, if true,
22 * do not attach the .bin extension to the new
23 * MacBinary */
24 public final static String PRESERVE_NAME = "PreserveName"; // Boolean
25 /** Action to be performed by a resource fork
26 * service */
27 public final static String RESOURCEFORK_ACTION = "RsrcForkAction"; // Integer from IRsrcForkAction
28 /** For loging into a system, if required */
29 public final static String SYSTEM_USER_ID = "SystemUserId"; // String
30 /** For loging into a system, if required */
31 public final static String SYSTEM_USER_PASSWORD = "SystemUserPassword"; // String
32 /** For loging into a system, if required */
33 public final static String DO_LOGIN = "DoLogin"; // Boolean
34 /** If true, delete the directory (usually a
35 * temp directory) */
36 public final static String DELETE_DIRECTORY = "DeleteDirectory"; // Boolean
37 /** If true, delete the original file after a
38 * conversion operation */
39 public final static String DELETE_ORIGINAL = "DeleteOriginal"; // Boolean
40 /** Used to specify the hotdirectory for this
41 * set of data */
42 public final static String HOT_DIRECTORY = "HotDirectory"; // String
43 /** Used to specify if files are to be added to
44 * the ASSETS_INPROCESS table */
45 public final static String ADD_TO_ASSETS_INPROCESS = "AddToAssetsInProcess"; // String
46 /** Used by the Thread Manager to start a new
47 * thread for this request in the specified
48 * thread group */
49 public final static String THREAD_GROUP_NAME = "ThreadGroupName"; // String
50 /** A holder of any type of error in the form
51 * of a Hashtable */
52 public final static String ERROR_HASHTABLE = "ErrorHashtable"; // Hashtable
53 /** A holder of bad files from a service in
54 * the form of a Hashtable */
55 public final static String BADFILES_HASHTABLE = "BadFilesHashtable"; // Hashtable
56 /** A holder of good files from a service in
57 * the form of a Hashtable */
58 public final static String GOODFILES_HASHTABLE = "GoodFilesHashtable"; // Hashtable
59 /** A property holding a url String */
60 public final static String URL_STRING = "UrlString"; // String
61 /** A property holding a message String */
62 public final static String MESSAGE_STRING = "MessageString"; // String
63 /** A holder of a Vector */
64 public final static String VECTOR_HOLDER = "VectorHolder"; // Vector
65 /** Used when a client must do multiple calls to
66 * the a service and to determine the number of
67 * the current call */
68 public final static String STEP_NUMBER = "StepNumber"; // Integer
69 /** Holds a record of bad records */
70 public final static String BADRECORDS_VECTOR = "BadRecordsVector"; // Vector
71 /** Tells the service if it is necessary to update
72 * the database status. Used by services that
73 * needs to do some sort of database status */
74 public final static String UPDATE_STATUS = "UpdateStatus"; // Boolean
75
76 /** Used in MetaData Service to find out if values
77 * for field containing lookup lists should be
78 * resolved to their value or leave them as ids */
79 public final static String RESOLVE_LOOKUPS = "ResolveLookups"; // Boolean
80
81 /** Used in MetaData Service to find ouf if buckets
82 * that return no meta data should be removed from
83 * the import data object or not */
84 public final static String DELETE_EMPTY_BUCKETS = "DeleteEmptyBuckets"; // Boolean
85
86 // Record Specific Properties
87 /** Id representing the AppleTalk Vendor for
88 * this asset */
89 public final static String APPLETALK_VENDOR = "AppleTalkVendor"; // Integer
90 /** The date and time for a check-in */
91 public final static String CHECKIN_DATETIME = "CheckInDateTime"; // String
92 /** if a service renames a file, this will
93 * contain the new file name; path will be in
94 * DESTINATION_LOCATION */
95 public final static String DESTINATION_FILENAME = "DestinationFileName"; // String
96 /** The destination path where the new file will
97 * be placed */
98 public final static String DESTINATION_LOCATION = "DestinationLocation"; // String
99 /** The destination server where the new file will
100 * be placed */
101 public final static String DESTINATION_SERVER = "DestinationServer"; // String
102 /** if a service renames a file, this will
103 * contain the original file name; path will be
104 * in ORIGINAL_LOCATION */
105 public final static String ORIGINAL_FILENAME = "OriginalFileName"; // String
106 /** The path where the original file was
107 * located */
108 public final static String ORIGINAL_LOCATION = "OriginalLocation"; // String
109 /** The server where the original file was
110 * located */
111 public final static String ORIGINAL_SERVER = "OriginalServer"; // String
112 /** Physical name of the asset to check-in */
113 public final static String FILENAME = "FileName"; // String
114 /** File size of the asset to check-in */
115 public final static String FILESIZE = "FileSize"; // Long
116 /** Indicates that the location is in the server
117 * or client machine */
118 public final static String IS_LOCATION_IN_SERVER = "IsLocationInServer"; // Boolean
119 /** If true, the move service should move
120 * lowres */
121 public final static String KEEP_LOWRES = "KeepLowres"; // Boolean
122 /** If true, handle the resource fork */
123 public final static String KEEP_RESOURCEFORK = "KeepResourceFork"; // Boolean
124 /** Physical path of the asset to check-in */
125 public final static String LOCATION = "Location"; // String
126 /** If true, files reside in SOURCE_LOCATION as
127 * MacBinaries */
128 public final static String MACBINARY_FORMAT = "MacBinaryFormat"; // Boolean
129 /**Don't split macbinaries**/
130 public final static String KEEP_MACBINARIES = "KeepMacBinaries"; // Boolean
131 /** Modification date **/
132 public final static String MODIFICATION_DATE = "ModDate"; // String - Date.toString()
133 /** If false, thumbnails are copied, not moved */
134 public final static String REGENERATE_THUMBNAIL = "RegenerateThumbnails"; // Boolean
135 /** The Role Id if this record data is an asset */
136 public final static String ROLE_ID = "RoleId"; // Integer
137 /** Server name (not DNS name) where asset to
138 * check-in is */
139 public final static String SERVER = "Server"; // String
140 /** Name of server where asset is currently
141 * located during check-out and check-in */
142 public final static String SOURCE_SERVER = "SourceServer"; // String
143 /** Path (not including file name) where asset
144 * is currently located during check-out and
145 * check-in */
146 public final static String SOURCE_LOCATION = "SourceLocation"; // String
147 /** File name of asset currently checked-out
148 * or checked-in */
149 public final static String SOURCE_FILENAME = "SourceFileName"; // String
150 /** File size of asset currently checked-out
151 * or checked-in */
152 public final static String SOURCE_FILESIZE = "SourceFileSize"; // Long
153 /** Original checked out path that will be stored
154 * in the database */
155 public final static String CHECKEDOUT_PATH = "CheckedOutPath"; // String
156 /** For versioning */
157 public final static String VERSION_FILENAME = "VersionFileName"; // String
158 public final static String VERSION_FILESIZE = "VersionFileSize"; // Long
159 public final static String VERSION_LOCATION = "VersionLocation"; // String
160 public final static String VERSION_NUMBER = "VersionNo"; // String
161 public final static String VERSION_NUMBER_PREVIOUS = "VersionNoPrevious"; // String
162 public final static String VERSION_SERVER = "VersionServer"; // String
163 /** For temporary storage of a date, used in
164 * Arch/Restore when a date needs to be set for
165 * Arch/Restore svcs, but Init service needs to
166 * start immediately.
167 * Setting the date in the ActionData object would
168 * result in the init service starting late. At
169 * the end of the initService, the date set in
170 * this property is used to set the date for the
171 * service (Arch/Restore), before it is added to
172 * the Queue. */
173 public final static String SERVICE_DATE = "ServiceDate"; // Date
174 /** To hold the list of files after they have
175 * been matched to Customer IDs by classLookup */
176 public final static String FILE_LIST = "FileList"; // Hashtable
177 /** To hold the list of resource fork files that
178 * need to be restored in a separate transaction */
179 public final static String RSRC_FILE_LIST = "RsrcFileList"; // Hashtable
180
181 // For Archive/Restore
182 /** The location where files will be restored */
183 public final static String RESTORE_LOCATION = "RestoreLocation"; // String
184 /** Flag to indicate whether or not the restore
185 * is flat mode or not */
186 public final static String IS_FLAT_MODE = "IsFlatMode"; // Boolean
187 /** Flag to indicate whether overwritting existing
188 * files is authorized or not */
189 public final static String IS_OVERWRITE = "IsOverwrite"; // Boolean
190 /** An ID assigned by the third party archive
191 * software (used to locate for restore) */
192 public final static String ARCHIVE_ID = "ArchiveID"; // String
193 /** An ID assigned by the third party archive
194 * software for the duplicate backup (used to
195 * locate for restore) */
196 public final static String DUP_ARCHIVE_ID = "DupArchiveID"; // String
197 /** An ID assigned by the third party archive
198 * software for the resource fork(used to locate
199 * for restore) */
200 public final static String RSRC_ARCHIVE_ID = "RsrcArchiveID"; // String
201 /** An ID assigned by the third party archive
202 * software for the resource fork backup (used to
203 * locate for restore) */
204 public final static String RSRC_DUP_ARCHIVE_ID = "RsrcDupArchiveID"; // String
205 /** To hold the error id of a transaction
206 * (returned by third party archive software) */
207 public final static String TPI_ERROR = "TPIErrorID"; // ArchTPIErrorKeys
208 /** To hold the error id of a transaction
209 * (equivalent internat flexstor.db error id) */
210 public final static String FLEX_ARCH_ERROR = "FlexErrorID";
211 /** When a file is archived, the path to the file
212 * is resolved and returned, then stored in
213 * the DB */
214 public final static String RESOLVED_LOCATION = "ResolvedLocation"; // String
215 /** Default View Asset Id for Asset */
216 public final static String DEFAULT_VIEW_ASSET_ID = "DefaultViewAssetID"; // Long
217 /** Set a record as a Default View Asset */
218 public final static String DEFAULT_VIEW_ASSET = "DefaultViewAsset"; // Boolean
219 /** Used to store the region name for archive
220 * software */
221 public final static String CUST_ID = "CustomerID";
222 public final static String RESTORE_SESSIONS = "RestoreSession"; // Hashtable
223 public final static String FILES_INPROGRESS = "FilesInProgress"; // Vector
224 public final static String HELD_RECORDS = "HeldRecords"; // Vector
225
226 // Properties for setting file permissions
227 /**
228 * Permissions (sPerms) can be entered in:
229 * Octal : preceed with a "0" as in "0777"
230 * Hex : preceed with "0x" as in "0x1ff"
231 * Decimal: no preceeding identifier as in "511"
232 *
233 * user group other
234 * rwx rwx rwx
235 */
236 public final static String FILE_PERMISSIONS = "FilePermissions"; // String
237 /** Id for the user */
238 public final static String FILE_USERID = "FileUserId"; // Integer
239 /** Id for the group */
240 public final static String FILE_GROUPID = "FileGroupId"; // Integer
241
242 // Constants for Edit
243 public final static String ACTION = "RO_Action"; //Int
244 public final static String SOURCE_RECORD = "RO_SourceRecord"; //TraversalInfo
245 public final static String CLASSIFIED = "RO_Classified"; //Boolean
246
247 // Properties used by the disk space service
248 /** Path of the volume containing this path */
249 public final static String VOLUME_PATH = "VolumePath"; // String
250 /** Size in bytes of the disk space required */
251 public final static String DISK_SPACE_REQUIRED = "DiskSpaceRequired"; // Long
252
253
254 // Constants for Send Service
255 public final static String SEND_ORIGINAL = "SendOriginal"; // Boolean
256 /** Use the convert service**/
257 public final static String USE_CONVERT_SERVICE = "UseConvertService"; // Boolean
258 /** Use the zip service**/
259 public final static String USE_ZIP_SERVICE = "UseZipService"; // Boolean
260 /** Manual data object **/
261 public final static String MANUAL_DATA = "ManualData"; // ActionData
262 /** Confirm data object **/
263 public final static String CONFIRMATION_DATA = "ConfirmData"; // ActionData
264 /** Confirmation Email text from remote service used by original local service**/
265 public final static String CONFIRM_TEXT = "ConfirmText"; // String
266 public final static String RESULT_STATUS = "ResultStatus"; // Boolean
267 /** Record description string **/
268 public final static String DESCRIPTION = "Description"; // String
269
270 /** SendService type selection <ServicesI.MIME, ServicesI.FTP, ServicesI.COPY> **/
271 public final static String SEND_SERVICE_TYPE = "SendServiceType"; // Integer
272
273 // Constants for Convert Service
274 /** Path of the conversion config file **/
275 public final static String CONVERT_CONFIG_FILE = "ConvertConfigFile"; // String
276 /** Specifies info only or convert + info <ServicesI.INFO, ServicesI.CONVERT> **/
277 public final static String CONVERSION_MODE = "ConversionMode"; // Integer
278 /** Conversion target path **/
279 public final static String CONVERSION_TARGET = "ConversionTarget"; // String
280
281 // Constants for Zip Service
282 /** Target zip file name **/
283 public final static String ZIP_FILENAME = "ZipFileName"; // String
284 /** Target zip path (including file name) **/
285 public final static String ZIP_FILEPATH = "ZipFilePath"; // String
286 /** Target zip path (not including file name) **/
287 public final static String ZIP_LOCATION = "ZipLocation"; // String
288
289 // Constants for FTP Service
290 /** Host name **/
291 public final static String FTP_HOST_NAME = "FTPHostName"; // String
292 /** User ID **/
293 public final static String FTP_USER_NAME = "FTPUserName"; // String
294 /** User password **/
295 public final static String FTP_PASSWORD = "FTPPassword"; // String
296 /** Transfer mode: true=binary, false=ascii **/
297 public final static String FTP_TRANSFER_MODE = "FTPTransferMode"; // Boolean
298 /** User-specified remote direcotry **/
299 public final static String FTP_REMOTE_DIR = "FTPRemoteDir"; // String
300 /** Create the remote dir(s) ?**/
301 public final static String FTP_CREATE_DIRS = "FTPCreateDirs"; // Boolean
302
303 // Email service (mime service) Constants
304 public final static String EMAIL_ADDRESS = "EmailAddress"; // String
305 public final static String EMAIL_SUBJECT = "EmailSubject"; // String
306 public final static String EMAIL_MESSAGE = "EmailMessage"; // String
307 public final static String EMAIL_SENDER = "EmailSender"; // String
308 public final static String EMAIL_CC = "EmailCC"; // String
309 /** The current value of the retry counter **/
310 public final static String EMAIL_RETRY_COUNT = "RetryCount"; // Integer
311
312 public final static String LOWRESEXTRACT_TARGET = "LowresExtractTarget"; // String
313
314 public final static String USE_EXTRACT_SERVICE = "UseExtractService"; // Boolean
315
316 public final static String CALLBACK_OBJECT = "CallbackObject"; // Object
317
318 /** Restore to origninal or new **/
319 public final static String RESTORE_ORIGINAL = "RestoreOriginal"; // Boolean
320
321 // The property containing the name of the cusomized process service to run
322 public final static String CUSTOMIZED_PROCESS = "CustomProcessName"; // String
323 }