Security.java

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <Security.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 Security extends MlpiComponent {
  /*
   * Constants
   */
  public static final int SECURIY_NETWORKSERVICE_MAX_NAME_LEN = 16;
  public static final int SECURIY_MAX_NETWORKSERVICES = 16;
  public static final int SECURITY_NETWORKCONFIGVALUE_MAX_NAME_LEN = 32;
  public static final int SECURITY_NETWORKCONFIGVALUE_MAX_VALUE_LEN = 128;
  public static final String SECURITY_NETWORKSERVICE_FTP = "FTP";
  public static final String SECURITY_NETWORKSERVICE_SSH = "SSH";
  public static final String SECURITY_NETWORKSERVICE_MLPI = "MLPI";
  public static final String SECURITY_NETWORKSERVICE_MLPIS = "MLPIS";
  public static final String SECURITY_NETWORKSERVICE_OPCUA = "OPCUA";

  /*
  * Enums
  */
  public static enum NetworkServiceState {
    MLPI_SECURITY_SERVICE_DISABLED(0),
    MLPI_SECURITY_SERVICE_ENABLED(1);
    
    private int _code;
    int getCode() { return _code; }
    NetworkServiceState(int code) { this._code = code; }
    static NetworkServiceState valueOf(int code) {
      for (NetworkServiceState value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  };
  public static enum NetworkServiceControl {
    MLPI_SECURITY_SERVICE_NOTCHANGEABLE (0x0000),
    MLPI_SECURITY_SERVICE_ACTIVATABLE   (0x0001),
    MLPI_SECURITY_SERVICE_DEACTIVATABLE (0x0002),
    MLPI_SECURITY_SERVICE_CHANGEABLE    (0x0003);
    
    private int _code;
    int getCode() { return _code; }
    NetworkServiceControl(int code) { this._code = code; }
    static NetworkServiceControl valueOf(int code) {
      for (NetworkServiceControl value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  };
  
  /*
   * Structs
   */
  
  public static class NetworkServiceInfo {
    public String networkServiceName;
    public NetworkServiceState networkServiceState;
    public NetworkServiceControl networkServiceControl;
  }
  
  public static class NetworkConfigurationValue {
    public String name;
    public String value;
  }   
  
  /*
   * Methods
   */
  
  Security(MlpiHandle connection) {
    super(connection);
  }
  
  public native NetworkServiceInfo[] getNetworkServiceInformation();
  
  @Deprecated
  public NetworkServiceInfo[] GetNetworkServiceInformation() {
    return getNetworkServiceInformation();
  }
  
  public native NetworkServiceState getNetworkServiceActivation(String service);
  
  @Deprecated
  public NetworkServiceState GetNetworkServiceActivation(String service) {
    return getNetworkServiceActivation(service);
  }
  
  public native void setNetworkServiceActivation(String service, NetworkServiceState state);
  
  @Deprecated
  public void SetNetworkServiceActivation(String service, NetworkServiceState state) {
    setNetworkServiceActivation(service, state);
  }

  public native NetworkConfigurationValue[] getNetworkServiceConfiguration(String service);
  
  @Deprecated
  public NetworkConfigurationValue[] GetNetworkServiceConfiguration(String service) {
    return getNetworkServiceConfiguration(service);
  }
  
  public native void setNetworkServiceConfiguration(String service, NetworkConfigurationValue[] configuration);
  
  @Deprecated
  public void SetNetworkServiceConfiguration(String service, NetworkConfigurationValue[] configuration) {
    setNetworkServiceConfiguration(service, configuration);
  }
}