All Downloads are FREE. Search and download functionalities are using the official Maven repository.

se.kth.iss.ug2.Ug2Protocol Maven / Gradle / Ivy

There is a newer version: 1.0.5
Show newest version
/*
 * MIT License
 *
 * Copyright (c) 2017 Kungliga Tekniska högskolan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package se.kth.iss.ug2;

/**
 * Definition of the Ug2 protocol
 */
public interface Ug2Protocol {
    public static final String PROTOCOL_VERSION_TAG = "protocolVersion";
    public static final String PROTOCOL_VERSION_MAJOR = "3";
    public static final String PROTOCOL_VERSION_MINOR = "9";

    public static final String OPERATION = "operation";

    public static final String OP_ACCUMULATE_GROUP_DATA = "accumulateGroupData";
    public static final String OP_ACCUMULATE_GROUPS = "accumulateGroups";
    public static final String OP_ACTIVATE_PROXY_SESSION = "activateProxySession";
    public static final String OP_ACTIVE_SESSIONS = "activeSessions";
    public static final String OP_ALL_OBJECTS_HAVING = "allObjectsHaving";
    public static final String OP_ALL_OBJECT_VALUES = "allObjectValues";
    public static final String OP_BLOCK_PERSONNUMMER = "blockPersonnummer";
    public static final String OP_CANDIDATE_USERS = "candidateUsers";
    public static final String OP_CHANGE_APP_DATA = "changeAppData";
    public static final String OP_CHANGE_DATA = "changeData";
    public static final String OP_CHANGE_OPERATOR_PASSWORD = "changeOperatorPassword";
    public static final String OP_CHANGE_PASSWORD = "changePassword";
    public static final String OP_CHANGE_USERNAME = "changeUsername";
    public static final String OP_CHECK_USERNAME = "checkUsername";
    public static final String OP_CREATE_ATTRIBUTE = "createAttribute";
    public static final String OP_CREATE_GROUP = "createGroup";
    public static final String OP_CREATE_SESSION = "createSession";
    public static final String OP_CREATE_PROXY_SESSION = "createProxySession";
    public static final String OP_CREATE_SSO_SESSION = "createSingleSignOnSession";
    public static final String OP_CREATE_SYSTEM = "createSystem";
    public static final String OP_CREATE_USER = "createUser";
    public static final String OP_CREATE_USER_SESSION = "createUserSession";
    public static final String OP_CURRENT_VERSION = "currentVersion";
    public static final String OP_DELETE_ATTRIBUTE = "deleteAttribute";
    public static final String OP_DELETE_GROUP = "deleteGroup";
    public static final String OP_DELETE_SYSTEM = "deleteSystem";
    public static final String OP_DELETE_USER = "deleteUser";
    public static final String OP_DESTROY_SESSIONS = "destroySessions";
    public static final String OP_DESTROY_SSO_SESSION = "destroySingleSignOnSession";
    public static final String OP_DESTROY_TICKETS = "destroyTickets";
    public static final String OP_DISABLE = "addToBlacklist";
    public static final String OP_DISABLE_ROLE = "disableRole";
    public static final String OP_DUMP_TICKETS = "dumpTickets";
    public static final String OP_ENABLE = "removeFromBlacklist";
    public static final String OP_ENABLE_ROLE = "enableRole";
    public static final String OP_FIND_BAD_VALUES = "findBadValues";
    public static final String OP_FIND_OBJECTS = "findObjects";
    public static final String OP_FORBID_HANDLE = "forbidHandle";
    public static final String OP_FUZZY_FIND = "fuzzyFind";
    public static final String OP_GENERATE_OTP_LIST = "generateOtpList";
    public static final String OP_GENERATE_TICKET = "generateTicket";
    public static final String OP_GET_ACCESS_TYPES = "getAccessTypes";
    public static final String OP_GET_APP_DATA = "getAppData";
    public static final String OP_GET_BLACKLIST_LOG = "getBlacklistLog";
    public static final String OP_GET_BLOCKED_PERSONNUMMER = "getBlockedPersonnummer";
    public static final String OP_GET_CHANGE_LOG_ENTRIES = "getChangeLogEntries";
    public static final String OP_GET_DATA = "getData";
    public static final String OP_GET_DATA_INDIRECT = "getDataIndirect";
    public static final String OP_GET_FORBIDDEN_LOG = "getForbiddenLog";
    public static final String OP_GET_GROUP_ADMIN_PROFILE = "getGroupAdminProfile";
    public static final String OP_GET_REFERENCES = "getReferences";
    public static final String OP_GET_SCHEMA = "getSchema";
    public static final String OP_GET_SESSION_INFO = "getSessionInfo";
    public static final String OP_GET_TICKET_INFO = "getTicketInfo";
    public static final String OP_PROPAGATION_ACKNOWLEDGE_PASSWORD = "propagationAcknowledgePassword";
    public static final String OP_PROPAGATION_GET_PASSWORD = "propagationGetPassword";
    public static final String OP_MEMBERSHIP = "membership";
    public static final String OP_MERGE_USERS = "mergeUsers";
    public static final String OP_MODIFY_ATTRIBUTE = "modifyAttribute";
    public static final String OP_OBJECTS_MATCHING = "objectsMatching";
    public static final String OP_PING = "ping";
    public static final String OP_PRE_PING = "prePing";
    public static final String OP_RECONFIGURE = "reconfigure";
    public static final String OP_REMOVE_OPERATOR_PASSWORD = "removeOperatorPassword";
    public static final String OP_RENAME_GROUP = "renameGroup";
    public static final String OP_REVERT_TO_AUTONAME = "revertToAutoname";
    public static final String OP_SET_DATA = "setData";
    public static final String OP_SET_NEW_OPERATOR_PASSWORD = "setNewOperatorPassword";
    public static final String OP_SET_NEW_PASSWORD = "setNewPassword";
    public static final String OP_SUGGEST_USERNAMES = "suggestUsernames";
    public static final String OP_TERMINATE_SESSION = "terminateSession";
    public static final String OP_TEST_DATA = "testData";
    public static final String OP_UNBLOCK_PERSONNUMMER = "unblockPersonnummer";
    public static final String OP_UNFORBID_HANDLE = "unforbidHandle";
    public static final String OP_USERS_MATCHING_FULLNAME = "usersMatchingFullname";
    public static final String OP_CREATE_IDCHECK_CODE = "createIdcheckCode";

    public static final String STATUS = "status";

    public static final String STATUS_OK = "OK";
    public static final String STATUS_WARNING = "WARNING";
    public static final String STATUS_SERVERERROR = "INTERNALSERVERERROR";
    public static final String STATUS_AUTHFAIL = "AUTHFAIL";
    public static final String STATUS_FAIL = "FAIL";
    public static final String STATUS_NOTFOUND = "NOTFOUND";
    public static final String STATUS_NOTUNIQUE = "NOTUNIQUE";
    public static final String STATUS_EXISTS = "EXISTS";
    public static final String STATUS_NOTPERMITTED = "NOTPERMITTED";
    public static final String STATUS_ILLEGALDATA = "ILLEGALDATA";
    public static final String STATUS_BLACKLIST = "BLACKLIST";
    public static final String PASSWORDENTRYNOTFOUND = "PASSWORDENTRYNOTFOUND"; // for PropagationGetPassword

    /*
     * The CODE is used to give a compact description of the DETAILS provided.
     */
    public static final String CODE = "code";
    public static final String CODE_SESSIONTERM = "sessionTerminated";
    public static final String CODE_TIMEOUTSESSIONTERM = "sessionTimedOut";
    public static final String CODE_INACTIVESESSIONTERM = "inactiveSessionTerminated";
    public static final String CODE_INACTIVITY = "inactivityWarning";

    public static final String CALLINGHOSTIPADDR = "callingHostIPAddress";

    public static final String REQUESTID = "requestID";
    public static final String FILLER = "filler";
    public static final String TIME = "time";
    public static final String TIME_OFFSET = "timeOffset";
    public static final String USER = "user";
    public static final String GROUP = "group";
    public static final String SYSTEM = "system";
    public static final String DETAILS = "details";
    public static final String ROLE = "role";

    public static final String AUTHENTICATED = "authenticated";
    public static final String SSHA1HASH = "ssha1";
    public static final String CREDENTIALS = "credentials";
    public static final String PASSWORD = "password";
    public static final String NEWPASSWORD = "newPassword";
    public static final String AUTHMETHOD = "authMethod";

    public static final String AM_PLAIN = "plain";
    public static final String AM_OTPLIST = "OTP-List";
    public static final String AM_PASSWORD = "password"; // Any password
    public static final String AM_SSO = "SSO"; // Single Sign On
    public static final String AM_CAS = "CAS"; // CAS proxy ticket (only for createUserSession)
    public static final String AM_IDCHECK_CODE = "idcheckCode"; // ID check code

    public static final String GIVENNAME = "givenName";
    public static final String FAMILYNAME = "familyName";
    public static final String USERNAME = "username";
    public static final String NAME = "Name";
    public static final String TYPE = "Type";
    public static final String FUZZY = "fuzzy";
    public static final String PRINCIPAL = "principal";
    public static final String PRINCIPALNAME = PRINCIPAL + NAME;
    public static final String PRINCIPALTYPE = PRINCIPAL + TYPE;
    public static final String SUBJECT = "subject";
    public static final String SUBJECTNAME = SUBJECT + NAME;
    public static final String SUBJECTTYPE = SUBJECT + TYPE;
    public static final String ISSUER = "issuer";
    public static final String ISSUERNAME = ISSUER + NAME;
    public static final String ISSUERTYPE = ISSUER + TYPE;
    public static final String RECEIVER = "receiver";
    public static final String RECEIVERNAME = RECEIVER + NAME;
    public static final String RECEIVERTYPE = RECEIVER + TYPE;

    public static final String DESTINATION_SESSION = "destinationSession";
    public static final String PRINCIPAL_FILTER = "principalFilter";
    public static final String IDCHECK_CODE = "idcheckCode";
    public static final String ACTIVATION_CODE = "activationCode";
    public static final String SERVICE_URL = "serviceURL";
    public static final String SSO_TOKEN = "singleSignOnToken";
    public static final String SESSIONID = "sessionId";
    public static final String TICKETID = "ticketId";
    public static final String TICKETHANDLE = "ticketHandle";
    public static final String TICK_SUBJECT = "ticketSubject";
    public static final String TICK_ISSUER = "ticketIssuer";
    public static final String TICK_RECEIVER = "ticketReceiver";
    public static final String TICK_CREATED = "ticketCreated";
    public static final String LENGTH = "length";
    public static final String DOMAIN = "domain";
    public static final String NUMOFLOOKUPS = "numOfLookups";
    public static final String NUMOFSECONDS = "numOfSeconds";
    public static final String CREATIONTIME = "creationTime";
    public static final String LASTACCESSED = "lastAccessedTime";
    public static final String LASTACTIVE = "lastActiveTime";
    public static final String CLIENTIP = "clientIp";
    public static final String SESSION = "session";
    public static final String APL = "apl";
    public static final String CPL = "cpl";
    public static final String ERL = "erl";
    public static final String OPERATOR = "operator";
    public static final String FACILITY = "facility";
    public static final String CRN = "crn"; // personnummer
    public static final String BIRTHDATE = "birthdate";
    public static final String PASSPORT = "passport";
    public static final String UG1NAME = "ug1name";
    public static final String KTHID = "kthid";
    public static final String NAME_EN = "name_en";
    public static final String NAME_SV = "name_sv";
    public static final String INHERIT_RIGHTS = "inheritRights";
    public static final String FILENAME = "fileName";
    public static final String NUMPASSWORDS = "numOfPasswords";
    public static final String RANK = "rank";
    public static final String WHO = "who";
    public static final String REASON = "reason";

    public static final String MESSAGE_DIGEST = "messageDigest";
    public static final String AUTHENTICATOR = "authenticator";

    public static final String SESSION_KEY = "sessionKey";
    public static final String SESSION_KEY_AGE_MAX = "sessionKeyAgeMax";
    public static final String SESSION_KEY_VERSION = "sessionKeyVersion";

    public static final String SERVER_ID = "serverSession";

    public static final String CLASS = "class";
    public static final String OBJECT = "object";
    public static final String OBJECTSTATUS = "objectStatus";
    public static final String LOOKUPATTR = "lookupAttribute";
    public static final String LOOKUPVALUE = "lookupValue";
    public static final String NUMLOOKUPVALS = "numOfLookupValues";
    public static final String KEY = "keyAttribute";
    public static final String REFATTR = "indirectAttribute";
    public static final String ADD = "add";
    public static final String REMOVE = "remove";
    public static final String GRANT = "grant";
    public static final String REVOKE = "revoke";
    public static final String ATTRIBUTE = "attribute";
    public static final String VALUE = "value";
    public static final String FORCE = "force";
    public static final String MESSAGE = "message";
    public static final String PARENT = "parent";
    public static final String KTHID_DELETE = "kthidDelete";
    public static final String KTHID_KEEP = "kthidKeep";
    public static final String TAG = "tag";
    public static final String EXCLUDE_DIRECT = "excludeDirect";
    public static final String EXCLUDE_INDIRECT = "excludeIndirect";

    public static final String TRUE = "true";
    public static final String FALSE = "false";

    public static final String ATTR_AGREEMENT_ITA = "agreement_ita";
    public static final String ATTR_AGREEMENT_DATE_SIGNED = "agreement_date_signed";
    public static final String ATTR_CLASS = "attributeClass";
    public static final String ATTR_NAME = "attributeName";
    public static final String ATTR_DESCRIPTION = "attributeDescription";
    public static final String ATTR_LABEL_EN = "attributeLabel_en";
    public static final String ATTR_LABEL_SV = "attributeLabel_sv";
    public static final String ATTR_UNIQ = "attributeUniq";
    public static final String ATTR_MULTI = "attributeMultiVal";
    public static final String ATTR_NOT_NULL = "attributeNotNull";
    public static final String ATTR_DOMAIN = "attributeDomain";
    public static final String ATTR_DOMAIN_CLASS = "attributeDomainClass";
    public static final String ATTR_DOMAIN_CHARS = "attributeDomainChars";
    public static final String ATTR_DOMAIN_MIN = "attributeDomainMin";
    public static final String ATTR_DOMAIN_MAX = "attributeDomainMax";
    public static final String ATTR_AUTO_CREATE = "attributeAutoCreate";
    public static final String ATTR_AUTO_DELETE = "attributeAutoDelete";
    public static final String ATTR_SPECIAL = "attributeSpecial";
    public static final String ATTR_PSEUDO = "attributePseudo";
    public static final String ATTR_CASE_INSENSITIVE = "attributeCaseInsensitive";
    public static final String ATTR_AUTO_ROLE = "autorole";
    public static final String ATTR_EMAIL_NAME = "email_name";
    public static final String ATTR_KTHID_SEARCH = "kthid_search";
    public static final String ATTR_ORCID = "orcid";
    public static final String ATTR_ORCID_CLAIMED = "orcid_claimed";
    public static final String ATTR_PERSONNUMMER = "personnummer";
    public static final String ATTR_ROLE = "role";
    public static final String ATTR_ROOM = "room";
    public static final String ACCESS = "access";
    public static final String ACCESS_HOLDER_CLASS = "accessHolderClass";
    public static final String ACCESS_HOLDER_KTHID = "accessHolderKthid";
    public static final String ACCESS_TARGET_CLASS = "accessTargetClass";
    public static final String ACCESS_TARGET_KTHID = "accessTargetKthid";
    public static final String ACCESS_TYPE = "accessType";
    public static final String ACCESS_GRANTER_CLASS = "accessGranterClass";
    public static final String ACCESS_GRANTER_KTHID = "accessGranterKthid";
    public static final String ACCESS_INHERITABLE = "inheritable";
    public static final String ACCESS_INCLUDE_INDIRECT = "includeIndirect";
    public static final String ACCESS_EXCLUDE_OBJECT_RIGHTS = "includeObjectRights";

    public static final String VERSION = "version";
    public static final String MIN_VERSION = "minVersion";
    public static final String MAX_VERSION = "maxVersion";
    public static final String MIN_TIME = "minTime";
    public static final String MAX_TIME = "maxTime";

    public static final String CHANGE_LOG_VERSION = "logVersion";
    public static final String CHANGE_LOG_TIME = "logTime";
    public static final String CHANGE_LOG_CLASS = "logClass";
    public static final String CHANGE_LOG_KTHID = "logKthid";
    public static final String CHANGE_LOG_ATTRIBUTE = "logAttribute";
    public static final String CHANGE_LOG_VALUE = "logValue";
    public static final String CHANGE_LOG_OPERATOR = "logOperator";
    public static final String CHANGE_LOG_OPERATION = "logOperation";
    public static final String CHANGE_LOG_FACILITY = "logFacility";
    public static final String CHANGE_LOG_SESSION = "logSession";
    public static final String CHANGE_LOG_REQUEST = "logRequest";
    public static final String CHANGE_LOG_TRANSACTION = "logTransaction";
    public static final String CHANGE_LOG_TRANSACTION_ITEM = "logTransactionItem";

    public static final String CAN_HAVE_CLASS = "canHaveClass";
    public static final String MUST_HAVE_CLASS = "mustHaveClass";
    public static final String CAN_HAVE_ATTRIBUTE = "canHaveAttribute";
    public static final String MUST_HAVE_ATTRIBUTE = "mustHaveAttribute";
    public static final String CAN_HAVE_KTHID = "canHaveKthid";
    public static final String MUST_HAVE_KTHID = "mustHaveKthid";

    public static final String CREATOR = "creator";
    public static final String ADMIN = "admin";
    public static final String EDITOR = "editor";

    public static final String INACTIVITY_WATCH = "inactivityWatch";

    public static final String IDCHECK_LEVEL = "idcheckLevel";
    public static final String IDCHECK_LEVEL_WEAK = "weak";
    public static final String IDCHECK_LEVEL_PERSONNUMMER = "personnummer";
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy