Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

kr.co.hit.live.util
Class PropertyHelper

java.lang.Object
  extended by kr.co.hit.live.util.PropertyHelper

public class PropertyHelper
extends Object

Property 관련 Live Framework의 Helper Class 프로퍼티 Key가 계층적으로 구성되어 있는 프로퍼티 파일 사용을 위한 기능을 제공한다. 또한 "${" 와 "}" 로 둘러싸인 형태의 참조 변수를 사용할 수 있다.

한번 생성된 Properties 객체들은 caching 하여 재사용된다.

프로퍼티 사용 예 
  ###### Common ########
  oracle.driver.simple=oracle.jdbc.driver.OracleDriver

  ########################################################
  # KHFC ZZ DB1
  ########################################################
  zzdb1.jdbc.driver=${oracle.driver.simple}
  zzdb1.jdbc.connectionurl=jdbc:oracle:thin:@172.17.200.13:1521:thns1
  zzdb1.jdbc.username=zz01
  zzdb1.jdbc.password=zz01
  zzdb1.jdbc.defaultautocommit=false

  ########################################################
  # KHFC SE DB1
  ########################################################
  sedb1.jdbc.driver=${oracle.driver.simple}
  sedb1.jdbc.connectionurl=jdbc:oracle:thin:@172.17.200.13:1521:thns1
  sedb1.jdbc.username=se01
  sedb1.jdbc.password=se01
  sedb1.jdbc.defaultautocommit=false

  ...

  // 프로그램 작성 예
  PropertyHelper ph = new PropertyHelper("live.jdbc.properties");
  Properties zzdb1Props = ph.getProperties("zzdb1");

  String driver = zzdb1Props.getProperty("jdbc.driver");  // oracle.jdbc.driver.OracleDriver

위와 같이 "zzdb1" 이나 "sedb1" 을 root key로 하여 그 하위 키를 접근하기 위한 기능을 제공한다.

Since:
3.0
Version:
$Revision: 1.1 $ $Date: 2006/09/26 08:20:11 $
Author:
김형도

Constructor Summary
PropertyHelper(String fileKey)
           PropertyHelper의 컨스트럭터 Live Framework property 파일에서 프로퍼티 파일명을 얻기 위한 키를 받는다.
PropertyHelper(String fileKey, String defaultfname)
           PropertyHelper의 컨스트럭터 Live Framework property 파일에서 프로퍼티 파일명을 얻기 위한 키를 받는다.
 
Method Summary
static Properties findProperties(String rootKey, Properties prop)
          Properties에서 rootKey로 시작하는 항목만 찾아서 새로운 Properties 객체에 담아 반환한다.
 boolean getBoolean(String rootKey, String subKey)
           "rootkey.subkey"를 키로하여 해당 Value를 boolean형으로 리턴한다.
 boolean getBoolean(String rootKey, String subKey, boolean defaultValue)
           "rootkey.subkey"를 키로하여 해당 Value를 boolean형으로 리턴한다.
 int getInt(String rootKey, String subKey)
           "rootkey.subkey"를 키로하여 해당 Value를 정수형으로 리턴한다.
 int getInt(String rootKey, String subKey, int defaultValue)
           "rootkey.subkey"를 키로하여 해당 Value를 정수형으로 리턴한다.
static String getInterpretedString(String key, Properties props)
           Properties에서 주어진 키에 해당되는 값을 반환하며, 반환 값에 참조 변수가 있다면 이를을 실제 값으로 치환화여 반환한다.
 long getLong(String rootKey, String subKey)
           "rootkey.subkey"를 키로하여 해당 Value를 Long 정수형으로 리턴한다.
 long getLong(String rootKey, String subKey, long defaultValue)
           "rootkey.subkey"를 키로하여 해당 Value를 Long 정수형으로 리턴한다.
 Properties getProperties()
           생성시에 설정된 프로퍼티 파일 키를 사용하여 해당 파일에 설정된 모든 Property 값들을 담은 Properties 객체를 리턴한다.
 Properties getProperties(String rootKey)
           rootkey.*.
 String getString(String rootKey, String subKey)
           "rootkey.subkey"를 키로하여 해당 Value를 String형으로 리턴한다.
 String getString(String rootKey, String subKey, String defaultValue)
           "rootkey.subkey"를 키로하여 해당 Value를 String형으로 리턴한다.
static String interpreteValue(String value, Properties props)
           참조 변수가 있는 문자열을 실제 값으로 치환화여 리턴한다.
protected static String interpreteValue(String base, Properties props, Set<String> priorRefs)
          주어진 base 문자열에 존재하는 참조 변수를 실제 값으로 치환하여 반환한다.
 long lastModified()
          해당 프로퍼티 파일이 마지막으로 변경된 시간을 반환함.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyHelper

public PropertyHelper(String fileKey)

PropertyHelper의 컨스트럭터 Live Framework property 파일에서 프로퍼티 파일명을 얻기 위한 키를 받는다.

PropertyHelper

public PropertyHelper(String fileKey,
                      String defaultfname)

PropertyHelper의 컨스트럭터 Live Framework property 파일에서 프로퍼티 파일명을 얻기 위한 키를 받는다. 주어진 키로 프로퍼티 파일명을 찾을 수 없을 경우 사용할 디폴트 파일명을 추가로 입력한다.

Method Detail

getString

public String getString(String rootKey,
                        String subKey)

"rootkey.subkey"를 키로하여 해당 Value를 String형으로 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
Returns:
원하고자하는 key값에 해당하는 value.

getString

public String getString(String rootKey,
                        String subKey,
                        String defaultValue)

"rootkey.subkey"를 키로하여 해당 Value를 String형으로 리턴한다. 해당되는 키가 없을 경우 defaultValue를 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
defaultValue - 해당되는 값을 없을 경우 리턴할 디폴트 값
Returns:
원하고자하는 key값에 해당하는 value.

getInt

public int getInt(String rootKey,
                  String subKey)

"rootkey.subkey"를 키로하여 해당 Value를 정수형으로 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
Returns:
원하고자하는 key값에 해당하는 value.

getInt

public int getInt(String rootKey,
                  String subKey,
                  int defaultValue)

"rootkey.subkey"를 키로하여 해당 Value를 정수형으로 리턴한다. 해당되는 키가 없을 경우 defaultValue를 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
defaultValue - 해당되는 값을 없을 경우 리턴할 디폴트 값
Returns:
원하고자하는 key값에 해당하는 value.

getLong

public long getLong(String rootKey,
                    String subKey)

"rootkey.subkey"를 키로하여 해당 Value를 Long 정수형으로 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
Returns:
원하고자하는 key값에 해당하는 value.

getLong

public long getLong(String rootKey,
                    String subKey,
                    long defaultValue)

"rootkey.subkey"를 키로하여 해당 Value를 Long 정수형으로 리턴한다. 해당되는 키가 없을 경우 defaultValue를 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
defaultValue - 해당되는 값을 없을 경우 리턴할 디폴트 값
Returns:
원하고자하는 key값에 해당하는 value.

getBoolean

public boolean getBoolean(String rootKey,
                          String subKey)

"rootkey.subkey"를 키로하여 해당 Value를 boolean형으로 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
Returns:
원하고자하는 key값에 해당하는 value.

getBoolean

public boolean getBoolean(String rootKey,
                          String subKey,
                          boolean defaultValue)

"rootkey.subkey"를 키로하여 해당 Value를 boolean형으로 리턴한다. 해당되는 키가 없을 경우 defaultValue를 리턴한다.

Parameters:
rootKey - 원하고자하는 rootkey값.
subKey - rootkey의 하위 key 값
defaultValue - 해당되는 값을 없을 경우 리턴할 디폴트 값
Returns:
원하고자하는 key값에 해당하는 value.

getProperties

public Properties getProperties(String rootKey)

rootkey.*.* 형태의 모든 프로퍼티를 모아서 하나의 Properties 객체로 리턴한다. 이때 리턴되는 Properties 객체는 rootkey를 제외한 하위 키를 사용하여 구성된다. 또한 Property 값들은 참조 변수가 모두 치환된 값들로 저장되어진다.

Parameters:
rootKey -
Returns:
Properties rootKey의 하위 키로 구성된 Properties 객체

getProperties

public Properties getProperties()

생성시에 설정된 프로퍼티 파일 키를 사용하여 해당 파일에 설정된 모든 Property 값들을 담은 Properties 객체를 리턴한다. 기존에 만들어진 Properties 객체가 있을 경우 이를 리턴하고, 처음 만들 경우에는 프로퍼티 파일 명을 Configurator를 통하여 가져온후 프로퍼티 파일을 사용하여 Properties 객체를 생성하여 리턴한다.

Returns:
Properties 프로퍼티 파일의 모든 프로퍼티 항목을 가지고 있는 Properties 객체, 오류 발생 시에는 비어있는 Properties 객체를 리턴한다.

lastModified

public long lastModified()
해당 프로퍼티 파일이 마지막으로 변경된 시간을 반환함.

Returns:

findProperties

public static Properties findProperties(String rootKey,
                                        Properties prop)
Properties에서 rootKey로 시작하는 항목만 찾아서 새로운 Properties 객체에 담아 반환한다. 참조 변수는 실제 값으로 치환되어진다.

Parameters:
rootKey -
prop -
Returns:

interpreteValue

public static String interpreteValue(String value,
                                     Properties props)

참조 변수가 있는 문자열을 실제 값으로 치환화여 리턴한다.

예) 

 Propreties props = new Properties();
 props.put("live.dir", "/web/live");
 props.put("live.log.dir", "${live.dir}/log");

 String value = PropertyHelper.interpreteValue("${live.log.dir}/common", props);
 System.out.println(value); //  /web/live/log/common

Parameters:
value - 문자열
prop - 치환 시 참조 변수값을 얻어오기 위한 Properties 객체
Returns:

getInterpretedString

public static String getInterpretedString(String key,
                                          Properties props)

Properties에서 주어진 키에 해당되는 값을 반환하며, 반환 값에 참조 변수가 있다면 이를을 실제 값으로 치환화여 반환한다.

예) 

 Propreties props = new Properties();
 props.put("live.dir", "/web/live");
 props.put("live.log.dir", "${live.dir}/log");
 props.put("live.log.common.dir", "${live.log.dir}/common");

 String value = PropertyHelper
                .getInterpretedString("live.log.common.dir", props);
 System.out.println(value); //  /web/live/log/common

Parameters:
value - 문자열
prop - 치환 시 참조 변수값을 얻어오기 위한 Properties 객체
Returns:

interpreteValue

protected static String interpreteValue(String base,
                                        Properties props,
                                        Set<String> priorRefs)
주어진 base 문자열에 존재하는 참조 변수를 실제 값으로 치환하여 반환한다.

Parameters:
base - 치환 대상 문자열
props - 참조 변수들의 실제 문자열이 들어 있는 Properties 객체
priorRefs - 치환 중에 현재까지 참조했던 참조 변수 집합
Returns:
참조 변수가 실제 값으로 치환된 문자열
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2014. All Rights Reserved.