| /* |
| * Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Sun designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Sun in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| * CA 95054 USA or visit www.sun.com if you need additional information or |
| * have any questions. |
| */ |
| |
| package com.sun.jmx.snmp; |
| |
| import java.io.Serializable; |
| |
| /** |
| * This class is used to pass some specific parameters to an <CODE> |
| * SnmpEngineFactory </CODE>. |
| * |
| * <p><b>This API is a Sun Microsystems internal API and is subject |
| * to change without notice.</b></p> |
| * @since 1.5 |
| */ |
| public class SnmpEngineParameters implements Serializable { |
| private static final long serialVersionUID = 3720556613478400808L; |
| |
| private UserAcl uacl = null; |
| private String securityFile = null; |
| private boolean encrypt = false; |
| private SnmpEngineId engineId = null; |
| |
| /** |
| * Sets the file to use for SNMP Runtime Lcd. If no file is provided, the default location will be checked. |
| */ |
| public void setSecurityFile(String securityFile) { |
| this.securityFile = securityFile; |
| } |
| |
| /** |
| * Gets the file to use for SNMP Runtime Lcd. |
| * @return The security file. |
| */ |
| public String getSecurityFile() { |
| return securityFile; |
| } |
| /** |
| * Sets a customized user ACL. User Acl is used in order to check |
| * access for SNMP V3 requests. If no ACL is provided, |
| * <CODE>com.sun.jmx.snmp.usm.UserAcl.UserAcl</CODE> is instantiated. |
| * @param uacl The user ACL to use. |
| */ |
| public void setUserAcl(UserAcl uacl) { |
| this.uacl = uacl; |
| } |
| |
| /** |
| * Gets the customized user ACL. |
| * @return The customized user ACL. |
| */ |
| public UserAcl getUserAcl() { |
| return uacl; |
| } |
| |
| /** |
| * Activate SNMP V3 encryption. By default the encryption is not activated. Be sure that the security provider classes needed for DES are in your classpath (eg:JCE classes) |
| * |
| */ |
| public void activateEncryption() { |
| this.encrypt = true; |
| } |
| |
| /** |
| * Deactivate SNMP V3 encryption. By default the encryption is not activated. Be sure that the security provider classes needed for DES are in your classpath (eg:JCE classes) |
| * |
| */ |
| public void deactivateEncryption() { |
| this.encrypt = false; |
| } |
| |
| /** |
| * Check if encryption is activated. By default the encryption is not activated. |
| * @return The encryption activation status. |
| */ |
| public boolean isEncryptionEnabled() { |
| return encrypt; |
| } |
| |
| /** |
| * Set the engine Id. |
| * @param engineId The engine Id to use. |
| */ |
| public void setEngineId(SnmpEngineId engineId) { |
| this.engineId = engineId; |
| } |
| |
| /** |
| * Get the engine Id. |
| * @return The engineId. |
| */ |
| public SnmpEngineId getEngineId() { |
| return engineId; |
| } |
| } |