javax.naming.ldap
클래스 LdapName

java.lang.Object 
  javax.naming.ldap.LdapName

모든 구현된 인터페이스:

Serializable, Cloneable, Comparable <Object >, Name

public class LdapName
extends Object 
implements Name 

이 클래스는 RFC 2253 으로 가리키는 식별명을 나타냅니다. 식별명 (DN)은 「상대 식별명 (RDN)」로 불리는 컴퍼넌트군의 순서 첨부 리스트입니다. DN 자세한 내용은 RFC 2253에 기재되어 있습니다.

이 클래스는 RFC 2253 으로 보여지는 몇개의 애매한 점을 분명히 합니다.

• RFC 2253 에서는 「공백」이라고 하는 말의 의미가 미정도리가 되어 있어, 대신에 ASCII 공백 문자 0x20 (" ")가 사용되고 있습니다.
• 공백은 콤마 (, ), 세미콜론 (;), 등호 (=), 플러스 기호 (+)의 좌우 어느 쪽 측에도 입력할 수 있습니다. 이러한 공백은 이 코드내에서 사용 가능하지만, 이 코드에 의해 생성될 것은 없고, 이름의 비교시에는 무시됩니다.
• 등호 (=)를 포함한 AttributeValue 캐릭터 라인이나, 행의 선두 이외의 위치에 있는 이스케이프 되지 않는 해시 기호 (#)도 사용 가능합니다.

LdapName에 게 건네지는 캐릭터 라인명이나 LdapName로 부터 리턴된 캐릭터 라인명은 완전한 Unicode 캐릭터 세트를 사용합니다. 이러한 캐릭터 라인명에는 「\\B4」와 같은 3 문자의 서브 캐릭터 라인으로 나타내지는 8중창마다, UTF-8에 encode 되는 문자를 포함할 수 있습니다 . 한편, 캐릭터 라인내의 단일의 문자로 나타내지는 8중창마다 UTF-8에 encode 되는 문자를 포함할 수 없습니다. 이 기술은, 미가 약간 애매합니다.

LdapName는 유효한 이름을 모두 적절히 해석하는 한편으로 무효인 이름의 해석시에는 위반의 가능성을 완전하게는 검출하지 않습니다. 즉, 무효인 이름에 대해서 「관대」입니다. 이름의 유효성은 최종적으로 LDAP 서버에게 건네진 시점에서 판정됩니다. LDAP 서버는 schema 정보나 상호 운용의 요건등의 각종 요인에 기반해 건네받은 이름을 받아들이는지 거부합니다.

동등성, 속성의 형태, 바이너리치 및 캐릭터 라인치의 테스트시에 이름을 구성하는 알파벳의 대문자와 소문자는 구별되지 않습니다. 인용, 이스케이프, UTF-8 16 진인코딩이 같으면, 캐릭터 라인치 그 자체가 차이가 나도, 동일한 캐릭터 라인이라고 보여집니다. 복수의 값을 가지는 RDN ( 「ou=Sales+cn=Bob」등)의 컴퍼넌트의 순서는 특히 중요하지는 않습니다.

LDAP 명의 컴퍼넌트 (RDN)에는 번호를 붙일 수 있고 있습니다. n개의 RDN 로부터 되는 LDAP 명의 인덱스의 범위는 0 ~ (n-1)여,[0, n]와 같이 기술됩니다. 제일 오른쪽의 RDN는 인덱스 0, 제일왼쪽의 RDN는 인덱스 n-1 입니다. 예를 들어 「CN=Steve Kille, O=Isode Limited, C=GB」라고 하는 식별명에는 {C=GB, O=Isode Limited, CN=Steve Kille} 오른쪽으로부터 순서에 0, 1, 2 순서로 번호를 붙일 수 있습니다. 비어있는 LDAP 명은 비어있는 RDN 리스트로 나타내집니다.

LdapName 인스턴스에 대한 읽기 전용 의 동시 multi-thread 액세스는 반드시 동기 시키지 않아도 괜찮습니다.

외로 지정이 없는 경우, null 인수를 생성자, 또는 이 클래스의 메서드에 건네주면, NullPointerException가 발생 됩니다.

도입된 버전 :

1.5

관련 항목:

직렬화 된 형식

생성자 개요

LdapName (List <Rdn > rdns)
해석이 끝난 RDN 컴퍼넌트를 지정해 LDAP 명을 작성합니다.

LdapName (String name)
식별명을 지정해 LDAP 명을 작성합니다.

메서드 개요

Name	add (int posn, Rdn comp) 단일의 RDN를, 이 LDAP 명의 지정의 위치에 추가합니다.
Name	add (int posn, String comp) 단일의 컴퍼넌트를, 이 LDAP 명의 지정의 위치에 추가합니다.
Name	add (Rdn comp) 단일의 RDN를 이 LDAP 명의 마지막에 추가합니다.
Name	add (String comp) 단일의 컴퍼넌트를 이 LDAP 명의 마지막에 추가합니다.
Name	addAll (int posn, List <Rdn > suffixRdns) 이름의 RDN를, 이 이름의 지정의 위치에 순서에 추가합니다.
Name	addAll (int posn, Name suffix) 이름의 컴퍼넌트를, 이 이름의 지정의 위치에 순서에 추가합니다.
Name	addAll (List <Rdn > suffixRdns) 이름의 RDN를, 이 이름의 말미에 순서에 추가합니다.
Name	addAll (Name suffix) 이름의 컴퍼넌트를, 이 이름의 말미에 순서에 추가합니다.
Object	clone () 이 이름의 복사본을 생성합니다.
int	compareTo (Object obj) LdapName와 지정된 Object 순서를 비교합니다.
boolean	endsWith (List <Rdn > rdns) 지정의 RDN 순서가 이 LDAP 명의 접미말이 될지 어떨지를 판정합니다.
boolean	endsWith (Name n) 이 LDAP 명이 지정의 LDAP 명의 접미말로 끝날지 어떨지가 판정됩니다.
boolean	equals (Object obj) 2개의 LDAP 명이 동일한지 어떤지를 판정합니다.
String	get (int posn) 이 LDAP 명의 컴퍼넌트를 캐릭터 라인으로서 취득합니다.
Enumeration <String >	getAll () 이 이름의 컴퍼넌트를, 캐릭터 라인의 열거로서 취득합니다.
Name	getPrefix (int posn) 컴퍼넌트가 이 LDAP 명의 컴퍼넌트의 접두사로 구성되는 이름을 작성합니다.
Rdn	getRdn (int posn) 이 LDAP 명의 RDN를 Rdn 로서 취득합니다.
List <Rdn >	getRdns () 상대 식별명의 리스트를 취득합니다.
Name	getSuffix (int posn) 컴퍼넌트가 이 LDAP 명의 컴퍼넌트의 접미말을 구성하는 이름을 작성합니다.
int	hashCode () 이 LDAP 명의 해시 코드를 계산합니다.
boolean	isEmpty () 이 LDAP 명이 비어있는지 판정합니다.
Object	remove (int posn) 이 LDAP 명으로부터 컴퍼넌트를 삭제합니다.
int	size () 이 LDAP 명의 컴퍼넌트수를 취득합니다.
boolean	startsWith (List <Rdn > rdns) 지정의 RDN 순서가 이 LDAP 명의 접두사가 될지 어떨지를 판정합니다.
boolean	startsWith (Name n) 이 LDAP 명이 지정의 LDAP 명의 접두사로 시작될지 어떨지가 판정됩니다.
String	toString () RFC 2253에 정의되어 클래스의 설명에 기재되어 있는 서식에서 이 LDAP 명의 캐릭터 라인 표현을 리턴합니다.

클래스 java.lang. Object 로부터 상속된 메서드

finalize, getClass, notify, notifyAll, wait, wait, wait

생성자 상세

LdapName

public LdapName(String  name)
         throws InvalidNameException 

식별명을 지정해 LDAP 명을 작성합니다.

파라미터:

name - RFC 2253 으로 지정된 서식의 null 이외의 식별명

예외:

InvalidNameException - 구문 위반이 검출되었을 경우

관련 항목:

Rdn.escapeValue(Object value)

LdapName

public LdapName(List <Rdn > rdns)

해석이 끝난 RDN 컴퍼넌트를 지정해 LDAP 명을 작성합니다.

리스트내의 RDN 인덱스는 클래스의 설명에 기술된 RDN 번호부에 따라 붙일 수 있습니다.

파라미터:

rdns - 이 LDAP 명을 구성하는 Rdn null 이외의 리스트

메서드의 상세

size

public int size()

이 LDAP 명의 컴퍼넌트수를 취득합니다.

정의:

인터페이스 Name 내의 size

반환값:

이 LDAP 명의 컴퍼넌트수. 0 이상

isEmpty

public boolean isEmpty()

이 LDAP 명이 비어있는지 판정합니다. 비어있는 이름은 컴퍼넌트가 제로의 이름입니다.

정의:

인터페이스 Name 내의 isEmpty

반환값:

이 LDAP 명이 비어있는 경우는 true, 그렇지 않은 경우는 false

getAll

public Enumeration <String > getAll()

이 이름의 컴퍼넌트를, 캐릭터 라인의 열거로서 취득합니다. 이 이름에 갱신하는 것에 한 열거에의 영향에 대해서는 정의되지 않습니다. 이름의 컴퍼넌트가 제로의 경우는 비어있는 (null 이외의) 열거가 리턴됩니다 . 이 열거에 포함되는 컴퍼넌트는 클래스의 설명에 기술되고 있는 대로 각각 붙일 수 있었던 번호순서가 되어 있습니다.

정의:

인터페이스 Name 내의 getAll

반환값:

이 LDAP 명의 컴퍼넌트의 null 이외의 열거. 열거된 각 요소의 클래스는 String

get

public String  get(int posn)

이 LDAP 명의 컴퍼넌트를 캐릭터 라인으로서 취득합니다.

정의:

인터페이스 Name 내의 get

파라미터:

posn - 얻는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

인덱스 위치의 null 이외의 컴퍼넌트

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

getRdn

public Rdn  getRdn(int posn)

이 LDAP 명의 RDN를 Rdn 로서 취득합니다.

파라미터:

posn - 얻는 RDN 0 으로부터 시작되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

인덱스 위치의 null 이외의 RDN

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

getPrefix

public Name  getPrefix(int posn)

컴퍼넌트가 이 LDAP 명의 컴퍼넌트의 접두사로 구성되는 이름을 작성합니다. 그 후 이 이름을 변경해도, 리턴된 이름에는 영향을 주지 않습니다. 또 역의 경우도 같습니다.

정의:

인터페이스 Name 내의 getPrefix

파라미터:

posn - 정지하는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

범위가 [0, posn] 인덱스로 컴퍼넌트를 구성하는 LdapName 인스턴스. 위값이 제로의 경우는 비어있는 LDAP 명이 리턴된다

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

getSuffix

public Name  getSuffix(int posn)

컴퍼넌트가 이 LDAP 명의 컴퍼넌트의 접미말을 구성하는 이름을 작성합니다. 그 후 이 이름을 변경해도, 리턴된 이름에는 영향을 주지 않습니다. 또 역의 경우도 같습니다.

정의:

인터페이스 Name 내의 getSuffix

파라미터:

posn - 개시하는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

범위가 [posn, size()] 인덱스로 컴퍼넌트를 구성하는 LdapName 인스턴스. 위값이 size()에 동일한 경우는 비어있는 LDAP 명이 리턴된다

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

startsWith

public boolean startsWith(Name  n)

이 LDAP 명이 지정의 LDAP 명의 접두사로 시작될지 어떨지가 판정됩니다. n 라는 이름은, getPrefix(n.size())와 동일한 경우에 접두사가 됩니다. 즉, 이 LDAP 명은 'n'로 개시됩니다. n가 null 인 경우나, 클래스의 설명에 있도록, RFC 2253 으로 지정된 서식이 아닌 경우는 false가 리턴됩니다 .

정의:

인터페이스 Name 내의 startsWith

파라미터:

n - 체크 대상의 LDAP 명

반환값:

n가 이 LDAP 명의 접두사인 경우는 true, 그렇지 않은 경우는 false

관련 항목:

getPrefix(int posn)

startsWith

public boolean startsWith(List <Rdn > rdns)

지정의 RDN 순서가 이 LDAP 명의 접두사가 될지 어떨지를 판정합니다. 이 LdapName가 rdns와 같은 길이여, 범위 [0, rdns.size()] 내의 위치 p 로 컴퍼넌트 getRdn(p)가 rdns.get(p)에 일치하는 경우, true가 리턴됩니다 . 그 외의 경우는 false가 리턴됩니다 . 또, rdns가 null인 경우, false가 리턴됩니다 .

파라미터:

rdns - 체크하는 Rdn 순서

반환값:

rdns가 이 LDAP 명의 접두사인 경우는 true, 그렇지 않은 경우는 false

endsWith

public boolean endsWith(Name  n)

이 LDAP 명이 지정의 LDAP 명의 접미말로 끝날지 어떨지가 판정됩니다. n 라는 이름은, getSuffix(size() -n.size())와 동일한 경우에 접미말이 됩니다. 즉, 이 LDAP 명은 'n'로 끝납니다. n가 null 인 경우나, 클래스의 설명에 있도록, RFC 2253 으로 지정된 서식이 아닌 경우는 false가 리턴됩니다 .

정의:

인터페이스 Name 내의 endsWith

파라미터:

n - 체크 대상의 LDAP 명

반환값:

n가 이 이름의 접미말인 경우는 true, 그렇지 않은 경우는 false

관련 항목:

getSuffix(int posn)

endsWith

public boolean endsWith(List <Rdn > rdns)

지정의 RDN 순서가 이 LDAP 명의 접미말이 될지 어떨지를 판정합니다. 이 LdapName가 rdns와 같은 길이여, 범위 [size() - rdns.size(), size()] 내의 위치 p 로 컴퍼넌트 getRdn(p)가 rdns.get(p)에 일치하는 경우, true가 리턴됩니다 . 그 외의 경우는 false가 리턴됩니다 . 또, rdns가 null인 경우, false가 리턴됩니다 .

파라미터:

rdns - 체크하는 Rdn 순서

반환값:

rdns가 이 LDAP 명의 접미말인 경우는 true, 그렇지 않은 경우는 false

addAll

public Name  addAll(Name  suffix)
            throws InvalidNameException 

이름의 컴퍼넌트를, 이 이름의 말미에 순서에 추가합니다.

정의:

인터페이스 Name 내의 addAll

파라미터:

suffix - 추가하는 null 이외의 컴퍼넌트

반환값:

갱신된 이름 (새로운 인스턴스는 아니다)

예외:

InvalidNameException - suffix가 유효한 이름은 아닌, 또는 컴퍼넌트의 추가가 이 LDAP 명의 구문 규칙에 위반하는 경우

addAll

public Name  addAll(List <Rdn > suffixRdns)

이름의 RDN를, 이 이름의 말미에 순서에 추가합니다.

파라미터:

suffixRdns - 추가하는 null 이외의 접미말 Rdn

반환값:

갱신된 이름 (새로운 인스턴스는 아니다)

addAll

public Name  addAll(int posn,
                   Name  suffix)
            throws InvalidNameException 

이름의 컴퍼넌트를, 이 이름의 지정의 위치에 순서에 추가합니다. 최초의 새로운 컴퍼넌트의 인덱스 위치, 또는 그것보다 뒤로 LDAP 명의 컴퍼넌트가 있는 경우, 이 컴퍼넌트는 새로운 컴퍼넌트에 대응할 수 있도록 위로 이동합니다 (0 으로부터 멀어진다).

정의:

인터페이스 Name 내의 addAll

파라미터:

suffix - 추가하는 null 이외의 컴퍼넌트

posn - 새로운 컴퍼넌트가 추가되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

갱신된 이름 (새로운 인스턴스는 아니다)

예외:

InvalidNameException - suffix가 유효한 이름은 아닌, 또는 컴퍼넌트의 추가가 이 LDAP 명의 구문 규칙에 위반하는 경우

IndexOutOfBoundsException. - 위값이 지정한 범위에 없는 경우

addAll

public Name  addAll(int posn,
                   List <Rdn > suffixRdns)

이름의 RDN를, 이 이름의 지정의 위치에 순서에 추가합니다. 최초의 새로운 RDN 인덱스 위치, 또는 그것보다 뒤로 LDAP 명의 RDN가 있는 경우, 이 RDN는 새로운 RDN를 수중에 넣을 수 있도록 위로 이동합니다 (인덱스 0 으로부터 멀어진다).

파라미터:

suffixRdns - 추가하는 null 이외의 접미말 Rdn

posn - RDN가 추가되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

갱신된 이름 (새로운 인스턴스는 아니다)

예외:

IndexOutOfBoundsException. - 위값이 지정한 범위에 없는 경우

add

public Name  add(String  comp)
         throws InvalidNameException 

단일의 컴퍼넌트를 이 LDAP 명의 마지막에 추가합니다.

정의:

인터페이스 Name 내의 add

파라미터:

comp - 추가하는 null 이외의 컴퍼넌트

반환값:

새로운 LdapName는 아니고, 갱신된 LdapName. null은 불가

예외:

InvalidNameException - 이름의 마지막에 컴퍼넌트를 추가하면, 이름의 구문에 위반하는 경우

add

public Name  add(Rdn  comp)

단일의 RDN를 이 LDAP 명의 마지막에 추가합니다.

파라미터:

comp - 추가하는 null 이외의 RDN

반환값:

새로운 LdapName는 아니고, 갱신된 LdapName. null은 불가

add

public Name  add(int posn,
                String  comp)
         throws InvalidNameException 

단일의 컴퍼넌트를, 이 LDAP 명의 지정의 위치에 추가합니다. 새로운 컴퍼넌트의 인덱스 위치, 또는 그것보다 뒤에 있는 이 LDAP 명의 컴퍼넌트는 새로운 컴퍼넌트를 수중에 넣기 위해서 1개 상에 이동 (인덱스 0 으로부터 멀어진다)합니다.

정의:

인터페이스 Name 내의 add

파라미터:

comp - 추가하는 null 이외의 컴퍼넌트

posn - 새로운 컴퍼넌트가 추가되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

새로운 LdapName는 아니고, 갱신된 LdapName. null은 불가

예외:

IndexOutOfBoundsException. - 위값이 지정한 범위에 없는 경우

InvalidNameException - 지정한 위치에 컴퍼넌트를 추가하면, 이름의 구문에 위반하는 경우

add

public Name  add(int posn,
                Rdn  comp)

단일의 RDN를, 이 LDAP 명의 지정의 위치에 추가합니다. 새로운 RDN 인덱스 위치, 또는 그것보다 뒤에 있는 이 LDAP 명의 RDN는 새로운 RDN를 수중에 넣기 위해서 1개 상에 이동 (인덱스 0 으로부터 멀어진다)합니다.

파라미터:

comp - 추가하는 null 이외의 RDN

posn - 새로운 RDN가 추가되는 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

새로운 LdapName는 아니고, 갱신된 LdapName. null은 불가

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

remove

public Object  remove(int posn)
              throws InvalidNameException 

이 LDAP 명으로부터 컴퍼넌트를 삭제합니다. 지정의 위치에 있는 이 이름의 컴퍼넌트가 삭제됩니다. 이 정도치보다 큰 인덱스의 컴퍼넌트는 1개 하 (인덱스 0 (분)편에)에 이동됩니다.

정의:

인터페이스 Name 내의 remove

파라미터:

posn - 삭제하는 컴퍼넌트의 인덱스. 범위는 [0, size()]가 아니면 안된다

반환값:

삭제된 컴퍼넌트 (String)

예외:

IndexOutOfBoundsException - 위값이 지정한 범위에 없는 경우

InvalidNameException - 컴퍼넌트의 삭제가 이 이름의 구문 규칙에 위반하는 경우

getRdns

public List <Rdn > getRdns()

상대 식별명의 리스트를 취득합니다. 리스트의 내용은 변경할 수 없습니다. 리턴된 리스트에 포함되는 RDN 인덱스는 클래스의 설명에 있도록, RDN 번호부에 따르고 있습니다. 이름에 포함되는 컴퍼넌트수가 제로의 경우, 비어있는 리스트가 리턴됩니다 .

반환값:

Rdn 클래스의 인스턴스인 RDN 리스트로 나타내지는 이름

clone

public Object  clone()

이 이름의 복사본을 생성합니다. 이 이름의 컴퍼넌트를 나중에 변경해도, 새로운 카피에는 영향을 주지 않습니다. 또 역의 경우도 같습니다.

정의:

인터페이스 Name 내의 clone

오버라이드(override):

클래스 Object 내의 clone

반환값:

이 LDAP 명의 카피

관련 항목:

Cloneable

toString

public String  toString()

RFC 2253에 정의되어 클래스의 설명에 기재되어 있는 서식에서 이 LDAP 명의 캐릭터 라인 표현을 리턴합니다. 이름에 포함되는 컴퍼넌트수가 제로의 경우, 비어있는 캐릭터 라인이 리턴됩니다 .

오버라이드(override):

클래스 Object 내의 toString

반환값:

LdapName 캐릭터 라인 표현

equals

public boolean equals(Object  obj)

2개의 LDAP 명이 동일한지 어떤지를 판정합니다. obj가 null 인지, LDAP 명이 아닌 경우는 false가 리턴됩니다 .

한편의 LDAP 명의 RDN가 이제(이미 ) 한편의 LDAP 명의 대응하는 RDN와 동일하면, 2개의 LDAP 명은 동일하게 됩니다. 이것은 2개의 LDAP 명이 같은 수의 RDN 로부터 구성되어 대응하는 각각의 RDN equals() 테스트가 true를 돌려주는 것을의미합니다. RDN 동등성의 정의에 대해서는 Rdn.equals(Object obj)를 참조하십시오.

오버라이드(override):

클래스 Object 내의 equals

파라미터:

obj - null 가능성이 있는 비교 대조 객체

반환값:

obj가 이 LDAP 명으로 동일한 경우는 true, 그렇지 않은 경우는 false

관련 항목:

hashCode()

compareTo

public int compareTo(Object  obj)

LdapName와 지정된 Object 순서를 비교합니다. 이 Name가 지정된 Object 보다 작은 경우는 부의 정수, 동일한 경우는 0, 큰 경우는 정의 정수를 각각 리턴합니다.

obj가 null 인지, LdapName 인스턴스가 아닌 경우는 ClassCastException가 발생 됩니다.

LDAP 명의 순서부는 문자를 비교할 때의 사전적인 규칙에 따릅니다. LDAP 명에 포함되는 모든 RDN에 확장자(extension)가 적용됩니다. 모든 RDN는 지정순서에 늘어놓을 수 있어 사전적으로 비교됩니다. RDN 비교 규칙에 대해서는 Rdn.compareTo(Object obj)를 참조하십시오.

이 LDAP 명이 사전적으로 obj 보다 짧은 경우, 부의 수가 리턴됩니다 . 이 LDAP 명이 사전적으로 obj 보다 긴 경우, 정의 수가 리턴됩니다 .

정의:

인터페이스 Comparable <Object > 내의 compareTo

정의:

인터페이스 Name 내의 compareTo

파라미터:

obj - 비교되는 null 이외의 LdapName

반환값:

이 Name가 지정된 obj 보다 작은 경우는 부의 정수, 동일한 경우는 0, 큰 경우는 정의 정수

예외:

ClassCastException - obj가 LdapName가 아닌 경우

관련 항목:

Comparable.compareTo(Object)

hashCode

public int hashCode()

이 LDAP 명의 해시 코드를 계산합니다. 해시 코드란 이 LDAP 명의 개개의 RDN 해시 코드의 집합입니다.

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

이 이름의 해시 코드를 나타내는 int

관련 항목:

equals(java.lang.Object)