javax.naming.directory
클래스 SearchControls

java.lang.Object 
  javax.naming.directory.SearchControls

모든 구현된 인터페이스:

Serializable

public class SearchControls
extends Object 
implements Serializable 

이 클래스는, 검색의 범위를 결정하는 요인, 및 검색의 결과로서 반환된 것을 캡슐화합니다.

SearchControls 인스턴스는, 병행 multi-thread 액세스에 대해서 동기화 되지 않습니다. 복수의 thread가 같은 SearchControls 인스턴스에 액세스 해 변경하려고 하면(자), 객체는 락 됩니다.

도입된 버젼:

1.3

관련 항목:

직렬화 된 형식

필드의 개요

static int	OBJECT_SCOPE 이름 첨부 객체를 검색합니다.
static int	ONELEVEL_SCOPE 이름 첨부 문맥의 1 개의 레벨을 검색합니다.
static int	SUBTREE_SCOPE 그 이름 첨부 객체를 루트로 하는 서브 트리 전체를 검색합니다.

생성자 의 개요

SearchControls ()
디폴트를 사용해 검색 조건을 구축합니다.

SearchControls (int scope, long countlim, int timelim, String [] attrs, boolean retobj, boolean deref)
인수를 사용해 검색 조건을 구축합니다.

메소드의 개요

long	getCountLimit () 검색의 결과로서 반환되는 엔트리의 최대수를 가져옵니다.
boolean	getDerefLinkFlag () 검색중에 링크가 간접 참조될지 어떨지를 판정합니다.
String []	getReturningAttributes () 검색의 일부로서 반환되는 속성을 가져옵니다.
boolean	getReturningObjFlag () 결과의 일부로서 객체가 돌려주어질지 어떨지를 판정합니다.
int	getSearchScope () 이러한 SearchControls 의 검색 범위를 가져옵니다.
int	getTimeLimit () 이러한 SearchControls 의 시간제한을 밀리 세컨드 단위로 가져옵니다.
void	setCountLimit (long limit) 검색의 결과로서 반환되는 엔트리의 최대수를 설정합니다.
void	setDerefLinkFlag (boolean on) 검색중의 링크에의 간접 참조를 유효 또는 무효로 합니다.
void	setReturningAttributes (String [] attrs) 검색의 일부로서 반환되는 속성을 지정합니다.
void	setReturningObjFlag (boolean on) 결과의 일부로서 객체를 돌려주는 것을 유효 또는 무효로 합니다.
void	setSearchScope (int scope) 검색 범위를 OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE 의 어떤 것이나 1 개로 설정합니다.
void	setTimeLimit (int ms) 이러한 SearchControls 의 시간제한을 밀리 세컨드 단위로 설정합니다.

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

clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

필드의 상세

OBJECT_SCOPE

public static final int OBJECT_SCOPE

이름 첨부 객체를 검색합니다.

OBJECT_SCOPE 를 사용해, search()에 의해 생성된 NamingEnumeration 에는, 1 또는 제로의 요소가 포함되어 있습니다. search()로 지정된 검색 필터를 이름 첨부 객체가 채우고 있는 경우, 열거안에 1 개의 요소가 포함됩니다. 요소는 그 이름으로서 빈 상태(empty)의 캐릭터 라인을 가집니다. 이것은 NamingEnumeration 의 요소의 이름이 타겟 문맥에 관련하고 있기 때문에, 이 경우, 타겟 문맥은 이름 첨부 객체입니다. search()로 지정된 검색 필터를 이름 첨부 객체가 채우지 않은 경우, 열거안에 요소는 포함되지 않습니다.

이 정수의 값은 0 입니다.

관련 항목:

정수 필드치

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

이름 첨부 문맥의 1 개의 레벨을 검색합니다.

ONELEVEL_SCOPE 를 사용해, search()에 의해 생성된 NamingEnumeration 에는, search()로 지정된 검색 필터를 채우는 이름 첨부 문맥의 객체를 가지는 요소가 포함되어 있습니다. NamingEnumeration 의 요소의 이름은, 이름 첨부 문맥에 관련한 원시명입니다.

이 정수의 값은 1 입니다.

관련 항목:

정수 필드치

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

그 이름 첨부 객체를 루트로 하는 서브 트리 전체를 검색합니다.

이름 첨부 객체가 DirContext 가 아닌 경우는, 객체 밖에 검색하지 않습니다. 이름 첨부 객체가 DirContext 의 경우는, 이름 첨부 객체 자체를 포함해, 이름 첨부 객체를 루트로 하는 서브 트리를 검색합니다.

검색은 네이밍 시스템의 범위내에서 행해집니다.

SUBTREE_SCOPE 를 사용해, search()에 의해 생성된 NamingEnumeration 에는, search()로 지정된 검색 필터를 채우는 서브 트리 (이름 첨부 문맥을 포함한다)의 객체의 요소가 포함되어 있습니다. NamingEnumeration 의 요소의 이름은, 이름 첨부 문맥에 관련하고 있는지, URL 캐릭터 라인일까의 어느 쪽인지입니다. 이름 첨부 문맥이 검색 필터를 채우고 있는 경우, 이름 첨부 문맥은, 이름으로서 빈 상태(empty)의 캐릭터 라인을 가지는 열거안에 포함됩니다.

이 정수의 값은 2 입니다.

관련 항목:

정수 필드치

생성자 의 상세

SearchControls

public SearchControls()

디폴트를 사용해 검색 조건을 구축합니다.

디폴트는 이하대로입니다.

• 1 개의 레벨을 검색
• 돌려주는 검색 결과의 최대수에 제한 없음
• 검색의 시간 제약 없음
• 검색 필터를 채우는 객체에 관련지을 수 있고 있는 속성을 모두 돌려준다
• 이름 첨부 객체는 돌려주지 않는다 (이름과 클래스 밖에 돌려주지 않는다)
• 검색중에 링크를 간접 참조하지 않는다

SearchControls

public SearchControls(int scope,
                      long countlim,
                      int timelim,
                      String [] attrs,
                      boolean retobj,
                      boolean deref)

인수를 사용해 검색 조건을 구축합니다.

파라미터:

scope - 검색 범위. 다음의 어떤 것인가 OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

timelim - 결과가 돌려주어질 때까지의 밀리 세컨드수. 0 의 경우, 무제한

deref - true 의 경우, 검색중에 링크를 간접 참조하는

countlim - 돌려주는 엔트리의 최대수. 0 의 경우, 필터를 채우는 엔트리를 모두 돌려주는

retobj - true 의 경우, 엔트리의 이름에 바인드 된 객체를 돌려준다. false 경우, 객체를 돌려주지 않는

attrs - 엔트리와 함께 돌려주는 속성의 식별자 null 의 경우, 모든 속성을 돌려준다. 빈 상태(empty)의 경우, 속성을 돌려주지 않는다

메소드의 상세

getSearchScope

public int getSearchScope()

이러한 SearchControls 의 검색 범위를 가져옵니다.

OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE 의 어떤 것이나 1 개

반환값:

이 SearchControls 의 검색 범위

관련 항목:

setSearchScope(int)

getTimeLimit

public int getTimeLimit()

이러한 SearchControls 의 시간제한을 밀리 세컨드 단위로 가져옵니다.

값이 0 의 경우, 무제한하게 기다리는 것을 의미합니다.

반환값:

이러한 SearchControls 의 밀리 세컨드 단위의 시간제한

관련 항목:

setTimeLimit(int)

getDerefLinkFlag

public boolean getDerefLinkFlag()

검색중에 링크가 간접 참조될지 어떨지를 판정합니다.

반환값:

링크가 간접 참조되는 경우는 true, 그렇지 않은 경우는 false

관련 항목:

setDerefLinkFlag(boolean)

getReturningObjFlag

public boolean getReturningObjFlag()

결과의 일부로서 객체가 돌려주어질지 어떨지를 판정합니다.

반환값:

객체가 반환되는 경우는 true, 그렇지 않은 경우는 false

관련 항목:

setReturningObjFlag(boolean)

getCountLimit

public long getCountLimit()

검색의 결과로서 반환되는 엔트리의 최대수를 가져옵니다.

0 은 모든 엔트리가 반환되는 것을 나타냅니다.

반환값:

반환되는 엔트리의 최대수

관련 항목:

setCountLimit(long)

getReturningAttributes

public String [] getReturningAttributes()

검색의 일부로서 반환되는 속성을 가져옵니다.

null 의 값은 모든 속성이 반환되는 것을 나타냅니다. 빈 상태(empty)의 배열은 속성이 아무것도 돌려주어지지 않은 것을 나타냅니다.

반환값:

반환되는 속성을 식별하는 속성 ID 의 배열 null 도 가능

관련 항목:

setReturningAttributes(java.lang.String[])

setSearchScope

public void setSearchScope(int scope)

검색 범위를 OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE 의 어떤 것이나 1 개로 설정합니다.

파라미터:

scope - 이 SearchControls 의 검색 범위

관련 항목:

getSearchScope()

setTimeLimit

public void setTimeLimit(int ms)

이러한 SearchControls 의 시간제한을 밀리 세컨드 단위로 설정합니다.

값이 0 의 경우, 무제한하게 기다리는 것을 의미합니다.

파라미터:

ms - 이러한 SearchControls 의 밀리 세컨드 단위의 시간제한

관련 항목:

getTimeLimit()

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)

검색중의 링크에의 간접 참조를 유효 또는 무효로 합니다.

파라미터:

on - 링크를 역참조하는 경우는 true, 그렇지 않은 경우는 false

관련 항목:

getDerefLinkFlag()

setReturningObjFlag

public void setReturningObjFlag(boolean on)

결과의 일부로서 객체를 돌려주는 것을 유효 또는 무효로 합니다.

무효로 했을 경우, 객체의 이름 및 클래스만이 돌려주어집니다. 유효하게 했을 경우, 객체가 돌려주어집니다.

파라미터:

on - true 의 경우, 객체가 반환된다. false 의 경우, 객체는 돌려주어지지 않은

관련 항목:

getReturningObjFlag()

setCountLimit

public void setCountLimit(long limit)

검색의 결과로서 반환되는 엔트리의 최대수를 설정합니다.

0 은 제한이 없는 것을 나타냅니다. 모든 엔트리가 돌려주어집니다.

파라미터:

limit - 반환되는 엔트리의 최대수

관련 항목:

getCountLimit()

setReturningAttributes

public void setReturningAttributes(String [] attrs)

검색의 일부로서 반환되는 속성을 지정합니다.

null 는 모든 속성이 반환되는 것을 나타냅니다. 빈 상태(empty)의 배열은 속성이 아무것도 돌려주어지지 않은 것을 나타냅니다.

파라미터:

attrs - 반환되는 속성을 식별하는 속성 ID 의 배열 null 도 가능

관련 항목:

getReturningAttributes()