/********************************************************* begin of preamble
**
** Copyright (C) 2003-2010 Software- und Organisations-Service GmbH.
** All rights reserved.
**
** This file may be used under the terms of either the
**
** GNU General Public License version 2.0 (GPL)
**
** as published by the Free Software Foundation
** http://www.gnu.org/licenses/gpl-2.0.txt and appearing in the file
** LICENSE.GPL included in the packaging of this file.
**
** or the
**
** Agreement for Purchase and Licensing
**
** as offered by Software- und Organisations-Service GmbH
** in the respective terms of supply that ship with this file.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
** IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
** THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
** PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
** BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
** CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
** SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
** INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
** CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
** ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
** POSSIBILITY OF SUCH DAMAGE.
********************************************************** end of preamble*/
package com.sos.JSHelper.Options;
import java.io.IOException;
import java.net.InetAddress;
import java.net.UnknownHostException;
import com.sos.JSHelper.Exceptions.JobSchedulerException;
/**
* \class SOSOptionHostName
*
* \brief SOSOptionHostName -
*
* \details
*
* \section SOSOptionHostName.java_intro_sec Introduction
*
* \section SOSOptionHostName.java_samples Some Samples
*
* \code
* .... code goes here ...
* \endcode
*
* <p style="text-align:center">
* <br />---------------------------------------------------------------------------
* <br /> APL/Software GmbH - Berlin
* <br />##### generated by ClaviusXPress (http://www.sos-berlin.com) #########
* <br />---------------------------------------------------------------------------
* </p>
* \author KB
* @version $Id: SOSOptionHostName.java 14729 2011-07-05 20:47:16Z sos $12.07.2010
* \see reference
*
* Created on 12.07.2010 14:02:15
*/
/**
* @author KB
*
*/
public class SOSOptionHostName extends SOSOptionElement {
/**
*
*/
private static final long serialVersionUID = 4006670598088800990L;
private final String conClassName = "SOSOptionHostName";
public static final String conLocalHostName = "localhost";
/**
* \brief SOSOptionHostName
*
* \details
*
* @param pobjParent
* @param pstrKey
* @param pstrDescription
* @param pstrValue
* @param pstrDefaultValue
* @param pflgIsMandatory
*/
public SOSOptionHostName(JSOptionsClass pobjParent, String pstrKey, String pstrDescription, String pstrValue, String pstrDefaultValue,
boolean pflgIsMandatory) {
super(pobjParent, pstrKey, pstrDescription, pstrValue, pstrDefaultValue, pflgIsMandatory);
// TODO Auto-generated constructor stub
}
/**
*
* \brief getHostAdress
*
* \details
*
* \return String
*
* @return
*/
public String getHostAdress() {
@SuppressWarnings("unused")
final String conMethodName = conClassName + "::getHostAdress";
String strIpAdress = "";
if (this.IsNotEmpty()) {
try {
strIpAdress = this.getInetAddress().getHostAddress();
}
catch (RuntimeException e) {
e.printStackTrace();
// throw new JobSchedulerException("RunTime Exception ", e);
}
}
return strIpAdress;
} // private String getHostAdress
/**
*
* \brief getInetAddress
*
* \details
*
* \return InetAddress
*
* @return
*/
public InetAddress getInetAddress() {
@SuppressWarnings("unused")
final String conMethodName = conClassName + "::getInetAdress";
InetAddress objInetAdress = null;
try {
objInetAdress = InetAddress.getByName(this.Value());
}
catch (UnknownHostException e) {
e.printStackTrace(System.err);
throw new JobSchedulerException("Unknown host ", e);
}
catch (RuntimeException e) {
e.printStackTrace(System.err);
throw new JobSchedulerException("RunTime Exception ", e);
}
return objInetAdress;
} // private InetAdress getInetAddress
/**
*
* \brief toString
*
* \details
*
* \return
*
* @return
*/
public String toString() {
@SuppressWarnings("unused")
final String conMethodName = conClassName + "::toString";
String strToString = "";
if (this.IsNotEmpty()) {
strToString = this.Value() + " (" + this.getHostAdress() + ")";
}
return strToString;
} // private String toString
/**
*
* \brief ping
*
* \details
*
* \return boolean
*
* @return
*/
public boolean ping() {
@SuppressWarnings("unused")
final String conMethodName = conClassName + "::ping";
boolean flgPingSuccessfull = false;
try {
flgPingSuccessfull = this.getInetAddress().isReachable(10000);
}
catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return flgPingSuccessfull;
} // private return_type ping
}