DeployAdmin (SafeIdentity Management API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.safeidentity.adminservice
Interface DeployAdmin

All Known Implementing Classes:: DeployManager

public interface DeployAdmin

Author:: kevin To change the template for this generated type comment go to Window - Preferences - Java - Code Generation - Code and Comments

Method Summary
`boolean`	`checkBaseLocation(java.lang.String dn)` LDAP 서버에 입력받은 dn위치에 엔트리가 달려있는지 검사해준다.
`void`	`close()` Connector에 연결된 저장소와의 연결을 종료한다.
`boolean`	`createBaseLocation(java.lang.String dn)` LDAP 서버에 입력받은 dn에 대한 엔트리를 달아준다.
`DeployWorker`	`createDeployWorker(java.util.Locale m_Locale)` SecurityContext를 생성하거나 삭제할 수 있는 Worker를 생성한다.
`URImportWorker`	`createURImportWorker(java.util.Locale locale, int fileType, java.io.File importFile, java.lang.String baseSfDn, java.lang.String adminSfDn)` UserRepository에 사용자 데이타를 넣어줄 Worker를 생성한다.
`void`	`deployPRSchema()` 정책저장소 구축에 필요한 스키마를 설치한다.
`void`	`deployURSchema(java.lang.String userOrgObjName, java.lang.String userObjName, java.lang.String dbURRootValue)` 사용자저장소 구축에 필요한 스키마를 설치한다.
`int`	`diffSchema(int type)` 서버에 있는 스키마와 Deploy할 파일의 스키마를 비교하여 상태 정보를 알려준다.
`java.util.Vector`	`getAttributeList(java.lang.String objName)` Object가 포함하고있는 속성(Ldap: attribute, DB: column)리스트를 가져온다.
`java.util.Vector`	`getDefaultMappedUserObjectList()` User에 대해서 기본으로 매핑관계가 설정되어 있는 Object리스트를 반환한다.
`java.util.Vector`	`getDefaultMappedUserOrgObjectList()` UserOrg에 대해서 기본으로 매핑관계가 설정되어 있는 Object리스트를 반환한다
`MapInfo`	`getDefaultUserMapping(java.lang.String objectName)` 해당 Object 클래스에 대해서 User 매핑 관계 설정시 기본으로 매핑 되어 있는 정보를 가져온다.
`MapInfo`	`getDefaultUserOrgMapping(java.lang.String objectName)` 해당 Object 클래스에 대해서 UserOrg 매핑 관계 설정시 기본으로 매핑 되어 있는 정보를 가져온다.
`java.lang.String`	`getDeploySchemaVersionInfo()` 배포용 SafeIdentity 스키마 버전 정보를 가져온다.
`java.util.Locale`	`getLocale()` Exception 메시지를 위한 로케일 정보를 가져온다.
`java.util.Vector`	`getObjectClassList()` 서버에 정의된 Object(Ldap: ObjectClass, DB: table)리스트를 가져온다.
`java.lang.String`	`getServerSchemaVersionInfo(int deployType)` 서버에 설치된 SafeIdentity 스키마 버전 정보를 가져온다.
`java.util.Vector`	`getSfUserMapAttributeList()` 매핑 설정시 필요한 SfUser의 속성 리스트를 가져온다.
`java.util.Vector`	`getSfUserOrgMapAttributeList()` 매핑 설정시 필요한 SfUserOrg의 속성 리스트를 가져온다.
`int`	`getUserOrgIDColumType(java.lang.String orgTabName, java.lang.String orgIdColName)` RDB의 경우에만 사용 기구축 사이트의UserOrg 테이블의 ID,PID에 해당하는 컬럼의 데이터타입을 반환.
`boolean`	`importInitialPRData()` Policy Repository에 초기에 들어갈 기본 데이타를 집어넣는다.
`boolean`	`isConnectServerOk()` 현재 설정으로 서버에 접속할 수 있는지를 테스트한다.
`boolean`	`isDeployable(int type)` 대상 서버에 Deploy가능한 경우 true 반환
`boolean`	`isUnDeployable(int type)` 대상 서버에 unDeploy가능한 경우 true 반환
`java.util.List`	`listRootBaseLocation()` LDAP 저장소에서 제공하는 RootContext(ex. o=base, dc=softforum,dc=com), 즉 최상위 DN으로 사용할 수 있는 목록을 가져온다.
`void`	`setDisplayTarget(Display display)` 진행 상황을 출력할 대상을 설정한다.
`void`	`setLocale(java.util.Locale locale)` Exception 메시지를 위한 로케일 정보를 변경한다.
`void`	`setServerConfig(ServerConfig config)` Server 접속 정보를 변경한다.
`void`	`unDeployPRSchema()` 정책저장소 구축에 필요한 스키마를 삭제한다.
`void`	`unDeployURSchema(java.lang.String userOrgObjName, java.lang.String userObjName)` 사용자저장소 구축에 필요한 스키마를 삭제한다.

Method Detail

setLocale

public void setLocale(java.util.Locale locale)

Exception 메시지를 위한 로케일 정보를 변경한다.

Parameters:: locale - 변경할 로케일 정보

getLocale

public java.util.Locale getLocale()

Exception 메시지를 위한 로케일 정보를 가져온다.

Returns:: 로케일 정보

setServerConfig

public void setServerConfig(ServerConfig config)
                     throws SFEnvParamException

Server 접속 정보를 변경한다.

Parameters:: config - deployment를 수행할 Sever 접속 정보
Throws:: SFEnvParamException

setDisplayTarget

public void setDisplayTarget(Display display)
                      throws SFDaoException,
                             SFEnvParamException

진행 상황을 출력할 대상을 설정한다. 출력 대상은 Display 인터페이스의 println을 꼭 구현해야한다.

Parameters:: display - 진행 상황을 출력할 대상
Throws:: SFDaoException; SFEnvParamException

isConnectServerOk

public boolean isConnectServerOk()
                          throws SFDaoException,
                                 SFEnvParamException,
                                 SFInvalidParameterException

현재 설정으로 서버에 접속할 수 있는지를 테스트한다.

Returns:: 서버접속 성공시 true
Throws:: SFDaoException; SFEnvParamException; SFInvalidParameterException

deployPRSchema

public void deployPRSchema()
                    throws SFEnvParamException,
                           SFBindException,
                           SFInvalidParameterException,
                           SFDaoException,
                           SFDeployException

정책저장소 구축에 필요한 스키마를 설치한다.

Throws:: SFEnvParamException; SFBindException; SFInvalidParameterException; SFDaoException; SFDeployException

deployURSchema

public void deployURSchema(java.lang.String userOrgObjName,
                           java.lang.String userObjName,
                           java.lang.String dbURRootValue)
                    throws SFEnvParamException,
                           SFBindException,
                           SFInvalidParameterException,
                           SFDaoException,
                           SFDeployException,
                           SFDeployException

사용자저장소 구축에 필요한 스키마를 설치한다.

Parameters:: userOrgObjName - 기존 시스템의 사용자조직 ObjectClass이름; userObjName - 기존 시스템의 사용자 ObjectClass이름
Throws:: SFEnvParamException; SFBindException; SFInvalidParameterException; SFDaoException; SFDeployException

unDeployPRSchema

public void unDeployPRSchema()
                      throws SFEnvParamException,
                             SFBindException,
                             SFInvalidParameterException,
                             SFDaoException,
                             SFDeployException

정책저장소 구축에 필요한 스키마를 삭제한다.

Throws:: SFEnvParamException; SFBindException; SFInvalidParameterException; SFDaoException; SFDeployException

unDeployURSchema

public void unDeployURSchema(java.lang.String userOrgObjName,
                             java.lang.String userObjName)
                      throws SFEnvParamException,
                             SFBindException,
                             SFInvalidParameterException,
                             SFDaoException,
                             SFDeployException,
                             SFDeployException

사용자저장소 구축에 필요한 스키마를 삭제한다.

Parameters:: userOrgObjName - 기존 시스템의 사용자조직 ObjectClass이름; userObjName - 기존 시스템의 사용자 ObjectClass이름
Throws:: SFEnvParamException; SFBindException; SFInvalidParameterException; SFDaoException; SFDeployException

getObjectClassList

public java.util.Vector getObjectClassList()
                                    throws SFEnvParamException,
                                           SFBindException,
                                           SFDaoException

서버에 정의된 Object(Ldap: ObjectClass, DB: table)리스트를 가져온다. Vector 반환값은 Object의 이름 리스트(String)을 담고있다.

Returns:: Object 리스트값
Throws:: SFEnvParamException; SFBindException; SFDaoException

getAttributeList

public java.util.Vector getAttributeList(java.lang.String objName)
                                  throws SFDaoException,
                                         SFEnvParamException,
                                         SFBindException

Object가 포함하고있는 속성(Ldap: attribute, DB: column)리스트를 가져온다. Vector 반환값은 속성 정의값(AttrInfo객체)를 가지고있다. 매핑 설정시 속성이 필수 필드이면 꼭 매핑 관계를 설정해 줘야된다.

Parameters:: objName - Object 이름
Returns:: 속성 리스트
Throws:: SFDaoException; SFEnvParamException; SFBindException

getSfUserOrgMapAttributeList

public java.util.Vector getSfUserOrgMapAttributeList()
                                              throws SFDaoException,
                                                     SFEnvParamException

매핑 설정시 필요한 SfUserOrg의 속성 리스트를 가져온다. Vector 반환값은 속성 정의값(AttrInfo객체)를 가지고있다.

Returns:: sfUserOrg의 매핑 가능 속성 리스트
Throws:: SFDaoException; SFEnvParamException

getSfUserMapAttributeList

public java.util.Vector getSfUserMapAttributeList()
                                           throws SFDaoException,
                                                  SFEnvParamException

매핑 설정시 필요한 SfUser의 속성 리스트를 가져온다. Vector 반환값은 속성 정의값(AttrInfo객체)를 가지고있다.

Returns:: sfUser의 매핑 가능 속성 리스트
Throws:: SFDaoException; SFEnvParamException

getDefaultMappedUserObjectList

public java.util.Vector getDefaultMappedUserObjectList()
                                                throws SFEnvParamException,
                                                       SFDaoException,
                                                       SFInvalidParameterException

User에 대해서 기본으로 매핑관계가 설정되어 있는 Object리스트를 반환한다.

Returns:: 매핑관계가 설정되 Object리스트
Throws:: SFDaoException; SFEnvParamException; SFInvalidParameterException

getDefaultMappedUserOrgObjectList

public java.util.Vector getDefaultMappedUserOrgObjectList()
                                                   throws SFEnvParamException,
                                                          SFDaoException,
                                                          SFInvalidParameterException

UserOrg에 대해서 기본으로 매핑관계가 설정되어 있는 Object리스트를 반환한다. * @return 매핑관계가 설정되 Object리스트

Throws:: SFDaoException; SFEnvParamException; SFInvalidParameterException

getDefaultUserOrgMapping

public MapInfo getDefaultUserOrgMapping(java.lang.String objectName)
                                 throws SFEnvParamException,
                                        SFDaoException,
                                        SFInvalidParameterException

해당 Object 클래스에 대해서 UserOrg 매핑 관계 설정시 기본으로 매핑 되어 있는 정보를 가져온다. 반환 값은 MapItemInfo 객체 형태로 매핑 정보가 담겨있다.

Parameters:: objectName - sfUserOrg에 매핑할 상위 Object클래스 이름
Returns:: 매핑 정보
Throws:: SFEnvParamException; SFDaoException; SFInvalidParameterException

getDefaultUserMapping

public MapInfo getDefaultUserMapping(java.lang.String objectName)
                              throws SFEnvParamException,
                                     SFDaoException,
                                     SFInvalidParameterException

해당 Object 클래스에 대해서 User 매핑 관계 설정시 기본으로 매핑 되어 있는 정보를 가져온다. 반환 값은 MapItemInfo 객체 형태로 매핑 정보가 담겨있다.

Parameters:: objectName - sfUser에 매핑할 상위 Object클래스 이름
Returns:: 배핑 정보
Throws:: SFEnvParamException; SFDaoException; SFInvalidParameterException

getServerSchemaVersionInfo

public java.lang.String getServerSchemaVersionInfo(int deployType)
                                            throws SFEnvParamException,
                                                   SFBindException,
                                                   SFDaoException,
                                                   SFInvalidParameterException

서버에 설치된 SafeIdentity 스키마 버전 정보를 가져온다. 서버에 SafeIdentity 스키마가 배포되지 않은 경우 ""를 리턴한다.

Parameters:: deployType - SFConst.DEPLOY_TYPE_PR --> Policy Repository SFConst.DEPLOY_TYPE_UR --> User Repository
Returns:: 서버에 설치된 스키마 버전
Throws:: SFEnvParamException; SFBindException; SFDaoException; SFInvalidParameterException

getDeploySchemaVersionInfo

public java.lang.String getDeploySchemaVersionInfo()

배포용 SafeIdentity 스키마 버전 정보를 가져온다.

Returns:: 배포용 스키마 버전

createDeployWorker

public DeployWorker createDeployWorker(java.util.Locale m_Locale)
                                throws SFEnvParamException

SecurityContext를 생성하거나 삭제할 수 있는 Worker를 생성한다.

Parameters:: m_Locale - Worker에서 출력할 메시지 로케일
Returns:: DeployWorker
Throws:: SFEnvParamException

importInitialPRData

public boolean importInitialPRData()
                            throws SFDaoException,
                                   SFInvalidParameterException,
                                   SFEnvParamException,
                                   SFBindException,
                                   SFDeployException

Policy Repository에 초기에 들어갈 기본 데이타를 집어넣는다.

Returns:: 성공시 true
Throws:: SFDaoException; SFInvalidParameterException; SFEnvParamException; SFBindException; SFDeployException

createURImportWorker

public URImportWorker createURImportWorker(java.util.Locale locale,
                                           int fileType,
                                           java.io.File importFile,
                                           java.lang.String baseSfDn,
                                           java.lang.String adminSfDn)
                                    throws SFEnvParamException

UserRepository에 사용자 데이타를 넣어줄 Worker를 생성한다.

Parameters:

locale - 출력 메시지용 Locale 정보

fileType - 입력받은 파일 타입

 SFConst.TYPE_IMPORT_FILE_CSV : csv 파일
 TYPE_IMPORT_FILE_EXCEL       : excel 파일

importFile - UserRepository 데이타 파일

baseSfDn - 사용자를 추가할 baseSfDn

adminSfDn - 사용자를 추가하는 관리자 sfDn

Returns:

사용자 데이타를 넣어줄 Worker

Throws:

SFEnvParamException

diffSchema

public int diffSchema(int type)
               throws SFDaoException,
                      SFInvalidParameterException,
                      SFEnvParamException,
                      SFBindException,
                      SFDeployException

서버에 있는 스키마와 Deploy할 파일의 스키마를 비교하여 상태 정보를 알려준다.

Parameters:

type - Deploy타입

 SFConst.DEPLOY_TYPE_PR PolicyRepository 타입
 SFConst.DEPLOY_TYPE_UR UserRepository 타입

Returns:

SCHEMA_UNDIFIED : 정의 안됨 SCHEMA_EXISTED : 스키마가 존재함 SCHEMA_NOT_EXISTED : 스키마가 설치되지 않았슴 SCHEMA_MODIFIED : 스키마가 수정되었슴

Throws:

SFDaoException

SFInvalidParameterException

SFEnvParamException

SFBindException

SFDeployException

isDeployable

public boolean isDeployable(int type)
                     throws SFDaoException,
                            SFInvalidParameterException,
                            SFEnvParamException,
                            SFBindException,
                            SFDeployException

대상 서버에 Deploy가능한 경우 true 반환

Parameters:

type - Deploy타입

Returns:

Deploy가능한 경우 true 반환

 SFConst.DEPLOY_TYPE_PR PolicyRepository 타입
 SFConst.DEPLOY_TYPE_UR UserRepository 타입

Throws:

SFDaoException

SFInvalidParameterException

SFEnvParamException

SFBindException

SFDeployException

isUnDeployable

public boolean isUnDeployable(int type)
                       throws SFDaoException,
                              SFInvalidParameterException,
                              SFEnvParamException,
                              SFBindException,
                              SFDeployException

대상 서버에 unDeploy가능한 경우 true 반환

Parameters:

type - Deploy타입

 SFConst.DEPLOY_TYPE_PR PolicyRepository 타입
 SFConst.DEPLOY_TYPE_UR UserRepository 타입

Returns:

unDeploy가능한 경우 true 반환

Throws:

SFDaoException

SFInvalidParameterException

SFEnvParamException

SFBindException

SFDeployException

getUserOrgIDColumType

public int getUserOrgIDColumType(java.lang.String orgTabName,
                                 java.lang.String orgIdColName)
                          throws SFEnvParamException,
                                 SFBindException,
                                 SFDaoException

RDB의 경우에만 사용 기구축 사이트의UserOrg 테이블의 ID,PID에 해당하는 컬럼의 데이터타입을 반환. 설정되지 않는다.

Parameters:: orgIdColName - 기구축 사이트의UserOrg 테이블의 ID 컬럼이름
Returns:: SFConst.DATATYPE_STRING ,SFConst.DATATYPE_INT, SFConst.DATATYPE_UNDEFINED
Throws:: SFEnvParamException; SFBindException; SFDaoException

checkBaseLocation

public boolean checkBaseLocation(java.lang.String dn)
                          throws SFEnvParamException,
                                 SFBindException

LDAP 서버에 입력받은 dn위치에 엔트리가 달려있는지 검사해준다.

Parameters:: dn - 검사할 dn
Returns:: 검사할 dn에 엔트리가 달려있으면 true, 달려있지않으면 false를 반환한다.
Throws:: SFEnvParamException; SFBindException

createBaseLocation

public boolean createBaseLocation(java.lang.String dn)
                           throws SFEnvParamException,
                                  SFBindException

LDAP 서버에 입력받은 dn에 대한 엔트리를 달아준다. 만약 dn에서 중간노드에 있는 엔트리가 없는 경우 자동으로 생성하면서 최종 dn에 엔트리를 생성한다.

 예를 들어 입력받은 dn이  o=test,dc=softforum,dc=com 일 경우
 1. dc=com  검사해서 없으면 엔트리 생성 
 2. dc=softforum,dc=com 검사해서 없으면 엔트리 생성
 3. o=test,dc=softforum,dc=com 검사해서 없으면 엔트리 생성
 
 엔트리  생성할때 해당 엔트리의 objectclass는 
 o= --> organization 
 dc= --> domain 
 ou= --> organizationalunit
 
 로 생성한다. 다른 타입은 현재 지원하지 않는다.

일단 dn에 해당하는 엔트리를 생성한다음 최종적으로 제대로 생성되었는지 검사해서, 생성이 된경우 true, 시스템 문제로 생성이 안된경우는 false를 반환한다.

Parameters:: dn - 엔트리를 생성할 dn
Returns:: dn에 대한 엔트리 생성이 된경우 true, 생성실퍠시 false 반환한다.
Throws:: SFEnvParamException; SFBindException

listRootBaseLocation

public java.util.List listRootBaseLocation()
                                    throws SFEnvParamException,
                                           SFBindException

LDAP 저장소에서 제공하는 RootContext(ex. o=base, dc=softforum,dc=com), 즉 최상위 DN으로 사용할 수 있는 목록을 가져온다.

Returns:: 최상위 DN 목록
Throws:: SFEnvParamException; SFBindException

close

public void close()

Connector에 연결된 저장소와의 연결을 종료한다.
이 함수는 Connector를 공통으로 사용할 때, 세션이 종료되면 명시적으로 호출되어야 한다. Connector.getUseCacheConnection()을 참고한다.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.safeidentity.adminservice Interface DeployAdmin

setLocale

getLocale

setServerConfig

setDisplayTarget

isConnectServerOk

deployPRSchema

deployURSchema

unDeployPRSchema

unDeployURSchema

getObjectClassList

getAttributeList

getSfUserOrgMapAttributeList

getSfUserMapAttributeList

getDefaultMappedUserObjectList

getDefaultMappedUserOrgObjectList

getDefaultUserOrgMapping

getDefaultUserMapping

getServerSchemaVersionInfo

getDeploySchemaVersionInfo

createDeployWorker

importInitialPRData

createURImportWorker

diffSchema

isDeployable

isUnDeployable

getUserOrgIDColumType

checkBaseLocation

createBaseLocation

listRootBaseLocation

close

com.safeidentity.adminservice
Interface DeployAdmin