AccessControl.java

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <AccessControl.java>
// -----------------------------------------------------------------------
// Copyright (c) 2012 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------
package com.boschrexroth.mlpi;

public class AccessControl extends MlpiComponent {
  /*
   * Constants
   */
  public static final int MLPI_MAX_USERNAME_LEN            = 32;
  public static final int MLPI_MAX_GROUPNAME_LEN           = 32;
  public static final int MLPI_MAX_INVALIDCHARS_LEN        = 32;
  public static final int MLPI_MAX_USER_DESCRIPTION_LEN    = 128;
  public static final int MLPI_MAX_GROUP_DESCRIPTION_LEN   = 128;
  public static final int MLPI_MAX_PERMISSION_LEN          = 128;
  
  /*
  * Enums
  */
  public static enum PersistenceType {
    MLPI_USER_PERSISTENCE_TYPE_TEMPORARY       (0),
    MLPI_USER_PERSISTENCE_TYPE_PERMANENT       (1);
    
    private int _code;
    int getCode() { return _code; }
    PersistenceType(int code) { this._code = code; }
    static PersistenceType valueOf(int code) {
      for (PersistenceType value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  };
  public static enum ExpirationTimeUnit {
  MLPI_ACCESSCONTROL_EXPIRATION_UNIT_MINUTES   (0),
  MLPI_ACCESSCONTROL_EXPIRATION_DAYS  (1);
    
    private int _code;
    int getCode() { return _code; }
    ExpirationTimeUnit(int code) { this._code = code; }
    static ExpirationTimeUnit valueOf(int code) {
      for (ExpirationTimeUnit value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  };
  /*
   * Structs
   */
  
  public static class UserInfo {
    public long            userId;
    public String          username;
    public String          description;
    public PersistenceType persistenceType;
    public boolean         disabled;
  }
  
  public static class ExpirationDetails {
    public boolean            enabled;
    public long               expirationTime;
    public ExpirationTimeUnit expirationTimeUnit;
  }
  
  public static class UserDetails {
    public long                       userId;
    public String                     username;
    public String                     description;
    public boolean                    disabled;
    public boolean                    userExpirationEnabled;
    public MlpiGlobal.DateAndTime     userExpirationTime;
    public ExpirationDetails          sessionExpiration;
    public PersistenceType            persistenceType;
  }
  
  
  public static class PasswordPolicies {
    public long minLength;
    public long maxLength;
    public long minUpperCase;
    public long minLowerCase;
    public long minNumerical;
    public long minSpecial;
  }
  
  public static class UserPolicies {
  public long                usernameMinLength;
  public long                usernameMaxLength;
  public String              usernameInvalidChars;
  public long                descriptionMinLength;
  public long                descriptionMaxLength;
  public ExpirationDetails   sessionExpirationSettings;
  }
  
  public static class GroupInfo {
    public long            groupId;
    public String          groupName;
    public String          description;
    public boolean         disabled;
  }
  
  public static class GroupPolicies {
  public long                groupNameMinLength;
  public long                groupNameMaxLength;
  public String              groupNameInvalidChars;
  public long                descriptionMinLength;
  public long                descriptionMaxLength;
  }
  
  public static class GroupDetails {
    public long                       groupId;
    public String                     groupName;
    public String                     description;
    public boolean                    disabled;
  }
  
  /*
   * Methods
   */
  
  AccessControl(MlpiHandle connection) {
    super(connection);
  }
  
  public native UserPolicies getUserPolicies();
  
  @Deprecated
  public UserPolicies GetUserPolicies() {
    return getUserPolicies();
  }
  
  public native PasswordPolicies getPasswordPolicies();
  
  @Deprecated
  public PasswordPolicies GetPasswordPolicies() {
    return getPasswordPolicies();
  }
  
  public native UserInfo[] getAllUserInfos();
  
  @Deprecated
  public UserInfo[] GetAllUserInfos() {
    return getAllUserInfos();
  }
  
  public native void addUser(UserDetails userDetails, String tmpPassword);
  
  @Deprecated
  public void AddUser(UserDetails userDetails, String tmpPassword) {
    addUser(userDetails, tmpPassword);
  }
  
  public native UserDetails getUser(String username);
  
  @Deprecated
  public UserDetails GetUser(String username) {
    return getUser(username);
  }
  
  public native void setUser(UserDetails userDetails);
  
  @Deprecated
  public void SetUser(UserDetails userDetails) {
    setUser(userDetails);
  }
  
  public native void deleteUser(String username);
  
  @Deprecated
  public void DeleteUser(String username) {
    deleteUser(username);
  }
  
  public native void changePassword(String username, String oldPassword, String newPassword);
  
  @Deprecated
  public void ChangePassword(String username, String oldPassword, String newPassword) {
    changePassword(username, oldPassword, newPassword);
  }
  
  public native GroupInfo[] getAllGroupInfos();
  
  @Deprecated
  public GroupInfo[] GetAllGroupInfos() {
    return getAllGroupInfos();
  }
  
  public native String[] getAllGroupsOfUser(String username);
  
  @Deprecated
  public String[] GetAllGroupsOfUser(String username) {
    return getAllGroupsOfUser(username);
  }
  
  public native String[] getAllUsersOfGroup(String groupName);
  
  @Deprecated
  public String[] GetAllUsersOfGroup(String groupName) {
    return getAllUsersOfGroup(groupName);
  }
  
  public native void addUserToGroup(String groupName, String username);
  
  @Deprecated
  public void AddUserToGroup(String groupName, String username) {
    addUserToGroup(groupName, username);
  }
  
  public native void removeUserFromGroup(String groupName, String username);
  
  @Deprecated
  public void RemoveUserFromGroup(String groupName, String username) {
    removeUserFromGroup(groupName, username);
  }
  
  public native void setUsersOfGroup(String groupName, String[] usernames);
  
  @Deprecated
  public void SetUsersOfGroup(String groupName, String[] usernames) {
    setUsersOfGroup(groupName, usernames);
  }
  
  public native void setGroupsOfUser(String username, String[] groupNames);
  
  @Deprecated
  public void SetGroupsOfUser(String username, String[] groupNames) {
    setGroupsOfUser(username, groupNames);
  }
  
  public native GroupPolicies getGroupPolicies();
  
  @Deprecated
  public GroupPolicies GetGroupPolicies() {
    return getGroupPolicies();
  }
  
  public native void resetPassword(String username, String newPassword);
  
  @Deprecated
  public void ResetPassword(String username, String newPassword) {
    resetPassword(username, newPassword);
  }
  
  public native void addGroup(GroupDetails groupDetails);
  
  @Deprecated
  public void AddGroup(GroupDetails groupDetails) {
    addGroup(groupDetails);
  }
  
  public native GroupDetails getGroup(String groupName);
  
  @Deprecated
  public GroupDetails GetGroup(String groupName) {
    return getGroup(groupName);
  }
  
  public native void setGroup(GroupDetails groupDetails);
  
  @Deprecated
  public void SetGroup(GroupDetails groupDetails) {
    setGroup(groupDetails);
  }
  
  public native void deleteGroup(String groupName);
  
  @Deprecated
  public void DeleteGroup(String groupName) {
    deleteGroup(groupName);
  }
  
  public native String[] getAllPermissions();
  
  @Deprecated
  public String[] GetAllPermissions() {
    return getAllPermissions();
  }
  
  public native void setPermissionsOfGroup(String groupName, String[] permissions);
  
  @Deprecated
  public void SetPermissionsOfGroup(String groupName, String[] permissions) {
    setPermissionsOfGroup(groupName, permissions);
  }
  
  public native String[] getAllPermissionsOfGroup(String groupName);
  
  @Deprecated
  public String[] GetAllPermissionsOfGroup(String groupName) {
    return getAllPermissionsOfGroup(groupName);
  }
  
  public native void setAuthorizedGroupsOfPermission(String permission, String[] groupNames);
  
  @Deprecated
  public void SetAuthorizedGroupsOfPermission(String permission, String[] groupNames) {
    setAuthorizedGroupsOfPermission(permission, groupNames);
  }
  
  public native String[] getAllAuthorizedGroupsOfPermission(String permission);
  
  @Deprecated
  public String[] GetAllAuthorizedGroupsOfPermission(String permission) {
    return getAllAuthorizedGroupsOfPermission(permission);
  }
  
  public native void addPermissionToGroup(String groupName, String permission);
  
  @Deprecated
  public void AddPermissionToGroup(String groupName, String permission) {
    addPermissionToGroup(groupName, permission);
  }
  
  public native void removePermissionFromGroup(String groupName, String permission);
  
  @Deprecated
  public void RemovePermissionFromGroup(String groupName, String permission) {
    removePermissionFromGroup(groupName, permission);
  }
  
}