001package org.apache.maven.scm.provider.jazz.command; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022/** 023 * @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a> 024 */ 025public class JazzConstants 026{ 027 // ------------------------------------------------------------------------------------------------- 028 // MISC. 029 // ------------------------------------------------------------------------------------------------- 030 031 /** 032 * Executable for Jazz SCM (Rational Team Concert). 033 */ 034 public static final String SCM_EXECUTABLE = "scm"; 035 036 /** 037 * Folder created by the SCM to store metadata. 038 */ 039 public static final String SCM_META_DATA_FOLDER = ".jazz5"; 040 041 /** 042 * SCM type identifier 043 */ 044 public static final String SCM_TYPE = "jazz"; 045 046 // ------------------------------------------------------------------------------------------------- 047 // COMMANDS 048 // ------------------------------------------------------------------------------------------------- 049 050 /** 051 * Accept command - Accept change sets into a repository workspace and load them into the local workspace. 052 */ 053 public static final String CMD_ACCEPT = "accept"; 054 055 /** 056 * Annotate command - Show line-by-line revision information for a file. 057 */ 058 public static final String CMD_ANNOTATE = "annotate"; 059 060 /** 061 * Checkin command - Check in locally modified files, adding them to the current change set. 062 */ 063 public static final String CMD_CHECKIN = "checkin"; 064 065 /** 066 * Create command - Can be used with a sub command to create a snapshot (tag) or repository workspace (branch). 067 */ 068 public static final String CMD_CREATE = "create"; 069 070 /** 071 * Deliver command - Deliver to a target. 072 */ 073 public static final String CMD_DELIVER = "deliver"; 074 075 /** 076 * Diff command - Compare two states of a file. 077 */ 078 public static final String CMD_DIFF = "diff"; 079 080 /** 081 * History command - Show the history of a file or component. 082 */ 083 public static final String CMD_HISTORY = "history"; 084 085 /** 086 * List command - List repository objects. 087 */ 088 public static final String CMD_LIST = "list"; 089 090 /** 091 * Load command - Load components from a repository workspace into a local workspace. 092 */ 093 public static final String CMD_LOAD = "load"; 094 095 /** 096 * Lock command - Used to lock or revoke locks on files in a stream. (requires 'acquire' or 'release' sub commands). 097 */ 098 public static final String CMD_LOCK = "lock"; 099 100 /** 101 * Snapshot command - Used to promote snapshots. Requires the 'promote' sub command. 102 */ 103 public static final String CMD_SNAPSHOT = "snapshot"; 104 105 /** 106 * Status command - Show modification status of items in a workspace. 107 */ 108 public static final String CMD_STATUS = "status"; 109 110 /** 111 * Changeset command - Modifies change sets. 112 */ 113 public static final String CMD_CHANGESET = "changeset"; 114 115 // ------------------------------------------------------------------------------------------------- 116 // SUB-COMMANDS 117 // ------------------------------------------------------------------------------------------------- 118 119 // CREATE sub commands 120 121 /** 122 * The 'type' (snapshot) of the create command. 123 */ 124 public static final String CMD_SUB_SNAPSHOT = "snapshot"; 125 126 /** 127 * The 'type' (workspace) of the create command. 128 */ 129 public static final String CMD_SUB_WORKSPACE = "workspace"; 130 131 /** 132 * The 'type' (changeset) of the create command. 133 */ 134 public static final String CMD_SUB_CHANGESET = "changeset"; 135 136 // LIST sub commands 137 138 /** 139 * List files in a remote workspace. 140 */ 141 public static final String CMD_SUB_REMOTEFILES = "remotefiles"; 142 143 /** 144 * List files in a remote workspace. 145 */ 146 public static final String CMD_SUB_CHANGESETS = "changesets"; 147 148 // LOCK sub commands 149 150 /** 151 * Locks files in a stream. 152 */ 153 public static final String CMD_SUB_ACQUIRE = "acquire"; 154 155 /** 156 * Revoke locks on files in a stream. 157 */ 158 public static final String CMD_SUB_RELEASE = "release"; 159 160 // SNAPSHOT sub commands 161 162 /** 163 * Promotes a snapshot to a stream or workspace. 164 */ 165 public static final String CMD_SUB_PROMOTE = "promote"; 166 167 // CHANGESET sub commands 168 169 /** 170 * Associate a Work Item with a change set. 171 */ 172 public static final String CMD_SUB_ASSOCIATE = "associate"; 173 174 // ------------------------------------------------------------------------------------------------- 175 // ARGUMENTS 176 // ------------------------------------------------------------------------------------------------- 177 178 /** 179 * Accept component additions and deletions (used with "accept" command). 180 */ 181 public static final String ARG_FLOW_COMPONENTS = "--flow-components"; 182 183 /** 184 * Overwrite existing files when loading (used with "load" command). 185 */ 186 public static final String ARG_FORCE = "--force"; 187 188 /** 189 * Local workspace path. 190 */ 191 public static final String ARG_LOCAL_WORKSPACE_PATH = "--dir"; 192 193 /** 194 * Load Root Directory. 195 */ 196 public static final String ARG_LOAD_ROOT_DIRECTORY = "--directory"; 197 198 /** 199 * The repository name. 200 */ 201 public static final String ARG_REPOSITORY_URI = "--repository-uri"; 202 203 /** 204 * Description for the snapshot (used with "create snapshot" command). 205 */ 206 public static final String ARG_SNAPSHOT_DESCRIPTION = "--description"; 207 208 /** 209 * Name of the snapshot (used with "create snapshot" command). 210 */ 211 public static final String ARG_SNAPSHOT_NAME = "--name"; 212 213 /** 214 * Forces the output to not shorten, otherwise the width will be based on the COLUMNS environment variable, or if 215 * that is not set, to 80 characters. (used with the "status" command). 216 */ 217 public static final String ARG_STATUS_WIDE_PRINT_OUT = "--wide"; 218 219 /** 220 * The user ID in the repository. 221 */ 222 public static final String ARG_USER_NAME = "--username"; 223 224 /** 225 * The user password in the repository. 226 */ 227 public static final String ARG_USER_PASSWORD = "--password"; 228 229 /** 230 * Description for the repository workspace (used with "create workspace" command). 231 */ 232 public static final String ARG_WORKSPACE_DESCRIPTION = "--description"; 233 234 /** 235 * Name of the repository workspace (used with "create workspace" command). 236 */ 237 public static final String ARG_WORKSPACE_NAME = "--name"; 238 239 /** 240 * Name of the repository workspace (used with "create workspace" command). 241 */ 242 public static final String ARG_WORKSPACE_SNAPSHOT = "--snapshot"; 243 244 /** 245 * Name of the source repository workspace (used with "deliver" command). 246 */ 247 public static final String ARG_DELIVER_SOURCE = "--source"; 248 249 /** 250 * Name of the target repository workspace or stream (used with "deliver" command). 251 */ 252 public static final String ARG_DELIVER_TARGET = "--target"; 253 254 /** 255 * Ignore uncommitted changes and deliver (used with "deliver" command). 256 */ 257 public static final String ARG_OVERWRITE_UNCOMMITTED = "--overwrite-uncommitted"; 258 259 /** 260 * Perform a file base diff (aftertype = file) (used with "diff" command). 261 */ 262 public static final String ARG_FILE = "file"; 263 264 /** 265 * Specify the maximum number of results to return, must be greater than zero. 266 * Used by numerous commands. 267 */ 268 public static final String ARG_MAXIMUM = "--maximum"; 269 270 /** 271 * Name of the repository workspace (used with "list changesets" command). 272 */ 273 public static final String ARG_WORKSPACE = "--workspace"; 274 275 /** 276 * Depth of files returned (used with "list remotefiles" command). 277 */ 278 public static final String ARG_DEPTH = "--depth"; 279 280 /** 281 * Depth is either numeric or '-' for all'. 282 */ 283 public static final String ARG_DEPTH_INFINTE = "-"; 284}