RangerConstants.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

 /**
 *
 */

package org.apache.ranger.common;

public class RangerConstants extends RangerCommonEnums {

	// Default Roles
	public final static String ROLE_SYS_ADMIN = "ROLE_SYS_ADMIN";
	public final static String ROLE_ADMIN = "ROLE_ADMIN";
	public final static String ROLE_INTEGRATOR = "ROLE_INTEGRATOR";
	public final static String ROLE_DATA_ANALYST = "ROLE_DATA_ANALYST";
	public final static String ROLE_BIZ_MGR = "ROLE_BIZ_MGR";
	public final static String ROLE_KEY_ADMIN = "ROLE_KEY_ADMIN";
	public final static String ROLE_USER = "ROLE_USER";
	public final static String ROLE_ANON = "ROLE_ANON";
	public final static String ROLE_OTHER = "ROLE_OTHER";
	public final static String GROUP_PUBLIC = "public";
	// Action constants
	public final static String ACTION_EDIT = "edit";
	public final static String ACTION_CHANGE = "change";
	public final static String ACTION_DELETE = "delete";
	public final static String ACTION_MARK_SPAM = "mark_spam";
	public final static String ACTION_RATE = "rate";
	public final static String ACTION_SELECT = "select";
	public final static String ACTION_UNSELECT = "unselect";
	public final static String ACTION_HIDE = "hide";
	public final static String ACTION_UNHIDE = "unhide";
	public final static String ACTION_SHARE = "share";
	public final static String ACTION_UNSHARE = "unshare";
	public final static String ACTION_BOOKMARK = "bookmark";
	public final static String ACTION_UNBOOKMARK = "unbookmark";

	// Sendgrid email API constants
	public static final String SENDGRID_API_USER = "api_user";
	public static final String SENDGRID_API_KEY = "api_key";
	public static final String SENDGRID_TO = "to";
	public static final String SENDGRID_TO_NAME = "toname";
	public static final String SENDGRID_SUBJECT = "subject";
	public static final String SENDGRID_TEXT = "text";
	public static final String SENDGRID_HTML = "html";
	public static final String SENDGRID_FROM_EMAIL = "from";
	public static final String SENDGRID_FROM_NAME = "fromname";
	public static final String SENDGRID_BCC = "bcc";
	public static final String SENDGRID_CC = "cc";
	public static final String SENDGRID_REPLY_TO = "replyto";

	//Permission Names
	public static final String MODULE_RESOURCE_BASED_POLICIES="Resource Based Policies";
	public static final String MODULE_USER_GROUPS="Users/Groups";
	public static final String MODULE_REPORTS="Reports";
	public static final String MODULE_AUDIT="Audit";
	public static final String MODULE_PERMISSION="Permissions";
	public static final String MODULE_KEY_MANAGER="Key Manager";
	public static final String MODULE_TAG_BASED_POLICIES="Tag Based Policies";

	// User create validation errors
	public enum ValidationUserProfile {

		NO_EMAIL_ADDR("xa.validation.userprofile.no_email_addr",
				"Email address not provided"), INVALID_EMAIL_ADDR(
				"xa.validation.userprofile.userprofile.invalid_email_addr",
				"Invalid email address"), NO_FIRST_NAME(
				"xa.validation.userprofile.userprofile.no_first_name",
				"First name not provided"), INVALID_FIRST_NAME(
				"xa.validation.userprofile.invalid_first_name",
				"Invalid first name"), NO_LAST_NAME(
				"xa.validation.userprofile.noemailaddr",
				"Email address not provided"), INVALID_LAST_NAME(
				"xa.validation.userprofile.noemailaddr",
				"Email address not provided"), NO_PUBLIC_SCREEN_NAME(
				"xa.validation.userprofile.noemailaddr",
				"Email address not provided"), INVALID_PUBLIC_SCREEN_NAME(
				"xa.validation.userprofile.noemailaddr",
				"Email address not provided");

		String rbKey;
		String message;

		ValidationUserProfile(String rbKey, String message) {
			this.rbKey = rbKey;
			this.message = message;
		}
	};

	// these constants will be used in setting GjResponse object.

	public final static String USER_PENDING_APPROVAL_MSG = "User is yet not reviewed by Administrator. Please contact at <number>.";
	public final static int USER_PENDING_APPROVAL_STATUS_CODE = 0;

	public final static String USER_APPROVAL_MSG = "User is approved";
	public final static int USER_APPROVAL_STATUS_CODE = 1;

	public final static String USER_REJECTION_MSG = "User is rejected";
	public final static int USER_REJECTION_STATUS_CODE = 1;

	public final static String USER_STATUS_ALREADY_CHANGED_MSG = "Can not change user status. it is either already activated/approved/rejected";
	public final static int USER_STATUS_ALREADY_CHANGED_STATUS_CODE = 0;

	public final static String USER_ALREADY_ACTIVATED_MSG = "Your account is already activated. If you have forgotten your password, then from the login page, select 'Forgot Password'";
	public final static int USER_ALREADY_ACTIVATED_STATUS_CODE = 0;

	public final static String USER_STATUS_NOT_ACTIVE_MSG = "User is not in active status. Please activate your account first.";
	public final static int USER_STATUS_NOT_ACTIVE_STATUS_CODE = 0;

	public final static String INVALID_EMAIL_ADDRESS_MSG = "Invalid email address";
	public final static int INVALID_EMAIL_ADDRESS_STATUS_CODE = 0;

	public final static String WRONG_ACTIVATION_CODE_MSG = "Wrong activation code";
	public final static int WRONG_ACTIVATION_CODE_STATUS_CODE = 0;

	public final static String VALID_EMAIL_ADDRESS_MSG = "Valid email address";
	public final static int VALID_EMAIL_ADDRESS_STATUS_CODE = 1;

	public final static String NO_ACTIVATION_RECORD_FOR_USER_ERR_MSG = "No activation record found for user:";
	public final static String NO_ACTIVATION_ENTRY = "activation entry not found";

	public final static String VALIDATION_INVALID_DATA_DESC = "Invalid value for";
	public final static int VALIDATION_INVALID_DATA_CODE = 0;
	public static final String GROUP_MODERATORS = "GROUP_MODERATORS";

	// public final static String EMAIL_WELCOME_MSG =
	// "Welcome to iSchoolCircle";
	// public final static String EMAIL_LINK_WELCOME_MSG =
	// "Welcome to iSchoolCircle ! Please verify your account by clicking on the link below: ";
	// public static final String EMAIL_EDIT_REJECTED_MSG =
	// "Your changes not approved for public sharing.";
	// public static final String EMAIL_APPROVAL_NEEDED_MSG =
	// "New objects pending approval";
	// public static final String EMAIL_PWD_RESET_CODE_MSG =

	public final static String PWD_RESET_FAILED_MSG = "Invalid password reset request";

	public final static String INVALID_NEW_PASSWORD_MSG = "Invalid new password";
	public static final String EMAIL_NEW_FEEDBACK_RECEIVED = "New feedback from";
	public static final int INITIAL_DOCUMENT_VERSION = 1;

	public static final int EMAIL_TYPE_ACCOUNT_CREATE = 0;
	public static final int EMAIL_TYPE_USER_CREATE = 1;
	public static final int EMAIL_TYPE_USER_ACCT_ADD = 2;
	public static final int EMAIL_TYPE_DOCUMENT_CREATE = 3;
	public static final int EMAIL_TYPE_DISCUSSION_CREATE = 4;
	public static final int EMAIL_TYPE_NOTE_CREATE = 5;
	public static final int EMAIL_TYPE_TASK_CREATE = 6;
	public static final int EMAIL_TYPE_USER_PASSWORD = 7;
	public static final int EMAIL_TYPE_USER_ACTIVATION = 8;
	public static final int EMAIL_TYPE_USER_ROLE_UPDATED = 9;
	public static final int EMAIL_TYPE_USER_GRP_ADD = 10;

	public static enum RBAC_PERM {
		ALLOW_NONE,
		ALLOW_READ,
		ALLOW_WRITE,
		ALLOW_DELETE
	}

}