001 /**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.rice.kim.api;
017
018 import org.kuali.rice.core.api.CoreConstants;
019 import org.kuali.rice.core.api.membership.MemberType;
020
021 import java.util.HashMap;
022 import java.util.Map;
023
024 public final class KimConstants {
025
026 public static final String KIM_MODULE_NAMESPACE = "KIM";
027
028 public static final String NAMESPACE_CODE = "KR-IDM";
029 public static final String KIM_TYPE_DEFAULT_NAMESPACE = "KUALI";
030 public static final String KIM_TYPE_RICE_NAMESPACE = "RICE";
031 public static final String KIM_TYPE_DEFAULT_NAME = "Default";
032 public static final String KIM_GROUP_DEFAULT_NAMESPACE_CODE = "KUALI";
033 public static final String KIM_GROUP_WORKFLOW_NAMESPACE_CODE = "KR-WKFLW";
034 public static final String RESTRICTED_DATA_MASK = "Xxxxxx";
035
036 public static final String KIM_PERSON_SERVICE = "personService";
037 public static final String DEFAULT_KIM_TYPE_SERVICE = "kimTypeService";
038
039 //Kim Attribute Boolean representations
040 public static final String KIM_ATTRIBUTE_BOOLEAN_TRUE_STR_VALUE_DISPLAY = "Yes";
041 public static final String KIM_ATTRIBUTE_BOOLEAN_FALSE_STR_VALUE_DISPLAY = "No";
042 public static final String KIM_ATTRIBUTE_BOOLEAN_TRUE_STR_VALUE = "Y";
043 public static final String KIM_ATTRIBUTE_BOOLEAN_FALSE_STR_VALUE = "N";
044
045 public static final class EntityTypes {
046 public static final String PERSON = "PERSON";
047 public static final String SYSTEM = "SYSTEM";
048
049 private EntityTypes() {
050 throw new UnsupportedOperationException("do not call");
051 }
052 }
053
054 public static final class AddressTypes {
055 public static final String HOME = "HM";
056 public static final String WORK = "WRK";
057 public static final String OTHER= "OTH";
058
059 private AddressTypes() {
060 throw new UnsupportedOperationException("do not call");
061 }
062 }
063
064 public static final class NameTypes {
065 public static final String PREFERRED = "PRFR";
066 public static final String PRIMARY = "PRM";
067 public static final String OTHER= "OTH";
068
069 private NameTypes() {
070 throw new UnsupportedOperationException("do not call");
071 }
072 }
073
074 public static final class GenderChangeCodes {
075 public static final String MALE_TO_FEMALE = "ChangeFemale";
076 public static final String FEMALE_TO_MALE = "ChangeMale";
077
078 private GenderChangeCodes() {
079 throw new UnsupportedOperationException("do not call");
080 }
081 }
082
083 public static final class PersonExternalIdentifierTypes {
084 public static final String TAX = "TAX";
085
086 private PersonExternalIdentifierTypes() {
087 throw new UnsupportedOperationException("do not call");
088 }
089 }
090 public static final class PersonAffiliationTypes {
091 public static final String STAFF_AFFILIATION_TYPE = "STAFF";
092 public static final String STUDENT_AFFILIATION_TYPE = "STUDENT";
093 public static final String AFFILIATE_AFFILIATION_TYPE = "AFFILIATE";
094 public static final String FACULTY_AFFILIATION_TYPE = "FACULTY";
095
096 private PersonAffiliationTypes() {
097 throw new UnsupportedOperationException("do not call");
098 }
099 }
100
101 public static final class PermissionTemplateNames {
102 public static final String FULL_UNMASK_FIELD = "Full Unmask Field";
103 public static final String PARTIAL_UNMASK_FIELD = "Partial Unmask Field";
104 public static final String VIEW_MAINTENANCE_INQUIRY_FIELD = "View Inquiry or Maintenance Document Field";
105 public static final String MODIFY_FIELD = "Modify Maintenance Document Field";
106 public static final String VIEW_SECTION = "View Inquiry or Maintenance Document Section";
107 public static final String MODIFY_SECTION = "Modify Maintenance Document Section";
108 public static final String CREATE_MAINTAIN_RECORDS = "Create / Maintain Record(s)";
109
110 public static final String EDIT_DOCUMENT = "Edit Document";
111 public static final String COPY_DOCUMENT = "Copy Document";
112 public static final String OPEN_DOCUMENT = "Open Document";
113 public static final String TAKE_REQUESTED_ACTION = "Take Requested Action";
114 public static final String INITIATE_DOCUMENT = "Initiate Document";
115 public static final String BLANKET_APPROVE_DOCUMENT ="Blanket Approve Document";
116 public static final String CANCEL_DOCUMENT ="Cancel Document";
117 public static final String SAVE_DOCUMENT ="Save Document";
118 public static final String ROUTE_DOCUMENT ="Route Document";
119 public static final String APPROVE_DOCUMENT = "Approve Document";
120 public static final String AD_HOC_REVIEW_DOCUMENT = "Ad Hoc Review Document";
121 public static final String ADD_MESSAGE_TO_ROUTE_LOG = "Add Message to Route Log";
122
123 public static final String ADD_NOTE_ATTACHMENT = "Add Note / Attachment";
124 public static final String VIEW_NOTE_ATTACHMENT = "View Note / Attachment";
125 public static final String DELETE_NOTE_ATTACHMENT = "Delete Note / Attachment";
126
127 public static final String USE_TRANSACTIONAL_DOCUMENT = "Use Transactional Document";
128
129 public static final String POPULATE_GROUP = "Populate Group";
130 public static final String ASSIGN_ROLE = "Assign Role";
131 public static final String GRANT_PERMISSION = "Grant Permission";
132 public static final String GRANT_RESPONSIBILITY = "Grant Responsibility";
133
134 public static final String LOOK_UP_RECORDS = "Look Up Records";
135 public static final String INQUIRE_INTO_RECORDS = "Inquire Into Records";
136 public static final String USE_SCREEN = "Use Screen";
137 public static final String BACKDOOR_RESTRICTION = "Backdoor Restriction";
138
139 public static final String PERFORM_CUSTOM_MAINTENANCE_DOCUMENT_FUNCTION ="Perform Custom Maintenance Document Function";
140 public static final String MAINTAIN_SYSTEM_PARAMETER = "Maintain System Parameter";
141 public static final String SEND_AD_HOC_REQUEST ="Send Ad Hoc Request";
142
143 public static final String EDIT_VIEW = "Edit View";
144 public static final String OPEN_VIEW = "Open View";
145 public static final String EDIT_FIELD = "Edit Field";
146 public static final String VIEW_FIELD = "View Field";
147 public static final String EDIT_GROUP = "Edit Group";
148 public static final String VIEW_GROUP = "View Group";
149 public static final String EDIT_WIDGET = "Edit Widget";
150 public static final String VIEW_WIDGET = "View Widget";
151 public static final String PERFORM_ACTION = "Perform Action";
152 public static final String EDIT_LINE = "Edit Line";
153 public static final String VIEW_LINE = "View Line";
154 public static final String EDIT_LINE_FIELD = "Edit Line Field";
155 public static final String VIEW_LINE_FIELD = "View Line Field";
156 public static final String PERFORM_LINE_ACTION = "Perform Line Action";
157
158 private PermissionTemplateNames() {
159 throw new UnsupportedOperationException("do not call");
160 }
161 }
162
163 public final static class PermissionNames {
164 public static final String LOG_IN = "Log In Kuali Portal";
165 public static final String ADMIN_PESSIMISTIC_LOCKING = "Administer Pessimistic Locking";
166 public static final String OVERRIDE_ENTITY_PRIVACY_PREFERENCES = "Override Entity Privacy Preferences";
167 public static final String MODIFY_ENTITY = "Modify Entity";
168 public static final String ACCESS_LOCKED_MODULE = "Access Locked Module";
169
170 private PermissionNames() {
171 throw new UnsupportedOperationException("do not call");
172 }
173 }
174
175 public final static class KimUIConstants {
176 public static final String NAME_VALUE_SEPARATOR = " : ";
177 public static final String COMMA_SEPARATOR = ", ";
178 public static final String OR_OPERATOR = "|";
179 public static final String URL_SEPARATOR = "/";
180 public static final String PARAMETERIZED_URL_SEPARATOR = "%2F";
181 public static final String KIM_URL_KEY = "kim.url";
182 public static final String KIM_APPLICATION = "kim";
183 public static final String MEMBER_ID_PREFIX = PrimaryKeyConstants.MEMBER_ID+".";
184 public static final String MEMBER_NAME = "memberName";
185 public static final String MEMBER_NAMESPACE_CODE = "memberNamespaceCode";
186 public static final String MEMBER_TYPE_PRINCIPAL = "Principal";
187 public static final String MEMBER_TYPE_GROUP = "Group";
188 public static final String MEMBER_TYPE_ROLE = "Role";
189 public static final Map<String, String> KIM_MEMBER_TYPES_MAP = getKimMemberTypesMap();
190 private static Map<String, String> getKimMemberTypesMap() {
191 Map<String, String> kimDocumentActionsMap = new HashMap<String, String>();
192 kimDocumentActionsMap.put(MemberType.PRINCIPAL.getCode(), MEMBER_TYPE_PRINCIPAL);
193 kimDocumentActionsMap.put(MemberType.GROUP.getCode(), MEMBER_TYPE_GROUP);
194 kimDocumentActionsMap.put(MemberType.ROLE.getCode(), MEMBER_TYPE_ROLE);
195 return kimDocumentActionsMap;
196 }
197
198 public static final String KIM_ROLE_DOCUMENT_TYPE_NAME = "IdentityManagementRoleDocument";
199 public static final String KIM_GROUP_DOCUMENT_TYPE_NAME = "IdentityManagementGroupDocument";
200 public static final String KIM_PERSON_DOCUMENT_TYPE_NAME = "IdentityManagementPersonDocument";
201 public static final String KIM_PERMISSION_DOCUMENT_TYPE_NAME = "IdentityManagementGenericPermissionMaintenanceDocument";
202 public static final String KIM_REVIEW_RESPONSIBILITY_DOCUMENT_TYPE_NAME = "IdentityManagementReviewResponsibilityMaintenanceDocument";
203 public static final String KIM_ROLE_DOCUMENT_SHORT_KEY = "IMRD";
204 public static final String KIM_GROUP_DOCUMENT_SHORT_KEY = "IMGD";
205 public static final String KIM_PERSON_DOCUMENT_SHORT_KEY = "IMPD";
206 public static final String KIM_GROUP_INQUIRY_SORT_DESC_VALUE = "KIM_GROUP_INQUIRY_SORT_DESC_VALUE";
207 public static final String KIM_GROUP_INQUIRY_SORT_PREV_COL_NM = "KIM_GROUP_INQUIRY_SORT_PREV_COL_NM";
208 public static final String KIM_ROLE_INQUIRY_SORT_DESC_VALUE = "KIM_ROLE_INQUIRY_SORT_DESC_VALUE";
209 public static final String KIM_ROLE_INQUIRY_SORT_PREV_COL_NM = "KIM_ROLE_INQUIRY_SORT_PREV_COL_NM";
210
211 public static final String KIM_ROLE_DOCUMENT_ACTION = "identityManagementRoleDocument.do";
212 public static final String KIM_ROLE_INQUIRY_ACTION = "identityManagementRoleInquiry.do";
213 public static final String KIM_PERSON_DOCUMENT_ACTION = "identityManagementPersonDocument.do";
214 public static final String KIM_PERSON_INQUIRY_ACTION = "identityManagementPersonInquiry.do";
215 public static final String KIM_GROUP_DOCUMENT_ACTION = "identityManagementGroupDocument.do";
216 public static final String KIM_GROUP_INQUIRY_ACTION = "identityManagementGroupInquiry.do";
217 public static final Map<String, String> KIM_DOCUMENTS_ACTIONS_MAP = getDocumentActionsMap();
218 private static Map<String, String> getDocumentActionsMap() {
219 Map<String, String> kimDocumentActionsMap = new HashMap<String, String>();
220 kimDocumentActionsMap.put(KIM_ROLE_DOCUMENT_SHORT_KEY, KIM_ROLE_DOCUMENT_ACTION);
221 kimDocumentActionsMap.put(KIM_GROUP_DOCUMENT_SHORT_KEY, KIM_GROUP_DOCUMENT_ACTION);
222 kimDocumentActionsMap.put(KIM_PERSON_DOCUMENT_SHORT_KEY, KIM_PERSON_DOCUMENT_ACTION);
223 return kimDocumentActionsMap;
224 }
225
226 public static final Map<String, String> KIM_DOCUMENT_TYPE_NAMES_MAP = getDocumentTypeNamesMap();
227 private static Map<String, String> getDocumentTypeNamesMap() {
228 Map<String, String> kimDocumentTypeNamesMap = new HashMap<String, String>();
229 kimDocumentTypeNamesMap.put(KIM_ROLE_DOCUMENT_SHORT_KEY, KIM_ROLE_DOCUMENT_TYPE_NAME);
230 kimDocumentTypeNamesMap.put(KIM_GROUP_DOCUMENT_SHORT_KEY, KIM_GROUP_DOCUMENT_TYPE_NAME);
231 kimDocumentTypeNamesMap.put(KIM_PERSON_DOCUMENT_SHORT_KEY, KIM_PERSON_DOCUMENT_TYPE_NAME);
232 return kimDocumentTypeNamesMap;
233 }
234
235 public static final String DELEGATION_PRIMARY = "P";
236 public static final String DELEGATION_SECONDARY = "S";
237 public static final String DELEGATION_PRIMARY_LABEL = "Primary";
238 public static final String DELEGATION_SECONDARY_LABEL = "Secondary";
239
240 public static final Map<String, String> DELEGATION_TYPES = getDelegationTypesMap();
241 private static Map<String, String> getDelegationTypesMap() {
242 Map<String, String> delegationTypesMap = new HashMap<String, String>();
243 delegationTypesMap.put(DELEGATION_PRIMARY, DELEGATION_PRIMARY_LABEL);
244 delegationTypesMap.put(DELEGATION_SECONDARY, DELEGATION_SECONDARY_LABEL);
245 return delegationTypesMap;
246 }
247
248 public static final String ROLE_LOOKUPABLE_IMPL = "roleLookupable";
249 public static final String KIM_DOCUMENT_ROLE_MEMBER_LOOKUPABLE_IMPL = "kimDocumentRoleMemberLookupable";
250 public static final String ROLE_MEMBER_LOOKUPABLE_IMPL = "roleMemberImplLookupable";
251 public static final String ROLE_MEMBERS_COLLECTION_NAME = "roleMembers";
252
253 private KimUIConstants() {
254 throw new UnsupportedOperationException("do not call");
255 }
256 }
257
258 public final static class PrimaryKeyConstants {
259 public static final String ENTITY_ID = "id";
260 public static final String SUB_ENTITY_ID = "entityId";
261 public static final String PRINCIPAL_ID = "principalId";
262 public static final String ROLE_ID = "id";
263 public static final String SUB_ROLE_ID = "roleId";
264 public static final String GROUP_ID = "id";
265 public static final String KIM_TYPE_ID = "id";
266 public static final String RESPONSIBILITY_ID = "id";
267 public static final String PERMISSION_ID = "id";
268 public static final String DELEGATION_ID = "delegationId";
269 public static final String MEMBER_ID = "memberId";
270 public static final String DELEGATION_MEMBER_ID = "delegationMemberId";
271 public static final String ROLE_MEMBER_ID = "roleMemberId";
272 public static final String ROLE_RESPONSIBILITY_ID = "roleResponsibilityId";
273 public static final String ROLE_RESPONSIBILITY_ACTION_ID = "roleResponsibilityActionId";
274 public static final String KIM_PERMISSION_REQUIRED_ATTR_ID = "kimPermissionRequiredAttributeId";
275 public static final String KIM_ATTRIBUTE_ID = "id";
276 public static final String KIM_TYPE_CODE ="id";
277 public static final String ID = "id";
278 public static final String CODE = "code";
279
280 private PrimaryKeyConstants() {
281 throw new UnsupportedOperationException("do not call");
282 }
283 }
284
285 public final static class UniqueKeyConstants {
286 public static final String NAMESPACE_CODE = "namespaceCode";
287 public static final String PRINCIPAL_NAME = "principalName";
288 public static final String GROUP_NAME = "name";
289 public static final String ROLE_NAME = "name";
290 public static final String PERMISSION_NAME = "name";
291 public static final String RESPONSIBILITY_NAME = "name";
292 public static final String PERMISSION_TEMPLATE_NAME = "name";
293 public static final String RESPONSIBILITY_TEMPLATE_NAME = "name";
294 public static final String NAME = "name";
295
296 private UniqueKeyConstants() {
297 throw new UnsupportedOperationException("do not call");
298 }
299 }
300
301 public final static class SequenceNames {
302 public static final String KRIM_PRNCPL_ID_S = "KRIM_PRNCPL_ID_S";
303 public static final String KRIM_ENTITY_ID_S = "KRIM_ENTITY_ID_S";
304 public static final String KRIM_ROLE_ID_S = "KRIM_ROLE_ID_S";
305 public static final String KRIM_GROUP_ID_S = "KRIM_GRP_ID_S";
306 public static final String KRIM_ROLE_PERM_ID_S = "KRIM_ROLE_PERM_ID_S";
307 public static final String KRIM_ROLE_RSP_ID_S = "KRIM_ROLE_RSP_ID_S";
308 public static final String KRIM_ROLE_MBR_ID_S = "KRIM_ROLE_MBR_ID_S";
309 public static final String KRIM_DLGN_MBR_ID_S = "KRIM_DLGN_MBR_ID_S";
310 public static final String KRIM_ROLE_RSP_ACTN_ID_S = "KRIM_ROLE_RSP_ACTN_ID_S";
311 public static final String KRIM_DLGN_ID_S = "KRIM_DLGN_ID_S";
312 public static final String KRIM_PERM_ID_S = "KRIM_PERM_ID_S";
313 public static final String KRIM_RSP_ID_S = "KRIM_RSP_ID_S";
314 public static final String KRIM_ATTR_DATA_ID_S = "KRIM_ATTR_DATA_ID_S";
315
316 private SequenceNames() {
317 throw new UnsupportedOperationException("do not call");
318 }
319 }
320
321 public final static class AttributeConstants {
322 public static final String PRINCIPAL_ID = "principalId";
323 public static final String PRINCIPAL_NAME = "principalName";
324 public static final String BUTTON_NAME = "buttonName";
325 public static final String BEAN_NAME = "beanName";
326 public static final String ACTION_CLASS = "actionClass";
327 public static final String NAME = "name";
328 public static final String NAMESPACE_CODE = "namespaceCode";
329 public static final String COMPONENT_NAME = "componentName";
330 public static final String PROPERTY_NAME = "propertyName";
331 public static final String EXISTING_RECORDS_ONLY = "existingRecordsOnly";
332 public static final String CREATED_BY_SELF = "createdBySelf";
333 public static final String CREATED_BY_SELF_ONLY = "createdBySelfOnly";
334 public static final String ATTACHMENT_TYPE_CODE = "attachmentTypeCode";
335 public static final String EDIT_MODE = "editMode";
336 public static final String PARAMETER_NAME = "parameterName";
337 public static final String CAMPUS_CODE = "campusCode";
338 public static final String ACTION_REQUEST_CD = "actionRequestCd";
339 public static final String ROUTE_STATUS_CODE = "routeStatusCode";
340 public static final String APP_DOC_STATUS = "appDocStatus";
341 public static final String ROUTE_NODE_NAME = "routeNodeName";
342 public static final String ROLE_NAME = "roleName";
343 public static final String PERMISSION_NAME = "permissionName";
344 public static final String RESPONSIBILITY_NAME = "responsibilityName";
345 public static final String ATTRIBUTE_NAME = "attributeName";
346 public static final String GROUP_NAME = "groupName";
347 public static final String REQUIRED = "required";
348 public static final String ACTION_DETAILS_AT_ROLE_MEMBER_LEVEL = "actionDetailsAtRoleMemberLevel";
349 public static final String DOCUMENT_NUMBER = "documentNumber";
350 public static final String DOCUMENT_TYPE_NAME = "documentTypeName";
351 public static final String APP_CODE = "appCode";
352 public static final String SECTION_ID = "sectionId";
353 public static final String KIM_TYPE_ID = PrimaryKeyConstants.KIM_TYPE_ID;
354 public static final String KIM_TYPE_NAME = "kimTypeName";
355 public static final String QUALIFIER_RESOLVER_PROVIDED_IDENTIFIER = "qualifierResolverProvidedIdentifier";
356 public static final String VIEW_ID = "viewId";
357 public static final String ACTION_EVENT = "actionEvent";
358 public static final String COLLECTION_PROPERTY_NAME = "collectionPropertyName";
359 public static final String FIELD_ID = "fieldId";
360 public static final String GROUP_ID = "groupId";
361 public static final String WIDGET_ID = "widgetId";
362 }
363
364 /**
365 *
366 * KimGroupS can contain other KimGroupS and KimPrincipalS.
367 * Use these constants to flags their members with the appropriate member
368 * type code.
369 *
370 * @author Kuali Rice Team (rice.collab@kuali.org)
371 */
372 public final static class KimGroupMemberTypes {
373
374 /**
375 * For group members that are themselves groups
376 */
377 public static final MemberType GROUP_MEMBER_TYPE = MemberType.GROUP;
378
379 /**
380 * For group members that are principals
381 */
382 public static final MemberType PRINCIPAL_MEMBER_TYPE = MemberType.PRINCIPAL;
383
384 private KimGroupMemberTypes() {
385 throw new UnsupportedOperationException("do not call");
386 }
387 }
388
389 private KimConstants() {
390 throw new UnsupportedOperationException("do not call");
391 }
392
393 public final static String SERVICE_PATH_SOAP = "soap/" + Namespaces.MODULE_NAME + "/" + CoreConstants.Versions.VERSION_2_0;
394
395 public final static class Namespaces {
396 public static final String MODULE_NAME = "kim";
397 public static final String KIM_NAMESPACE_PREFIX = CoreConstants.Namespaces.ROOT_NAMESPACE_PREFIX + "/" + MODULE_NAME;
398
399 public static final String KIM_NAMESPACE_2_0 = KIM_NAMESPACE_PREFIX + "/" + CoreConstants.Versions.VERSION_2_0;
400 }
401
402 public static class ParameterKey {
403 public static final String SHOW_BLANK_QUALIFIERS = "KIM_SHOW_BLANK_QUALIFIERS";
404 }
405
406 }