javax.naming.ldap
클래스 SortResponseControl

java.lang.Object 
  javax.naming.ldap.BasicControl 
      javax.naming.ldap.SortResponseControl

모든 구현된 인터페이스:

Serializable, Control

public final class SortResponseControl
extends BasicControl 

검색 결과가 요구대로 소트 되었는지 어떠했는지를 나타냅니다. 결과 코드가 성공을 나타내고 있는 경우, 검색 결과는 요구대로 소트 되고 있습니다. 그렇지 않은 경우는 소트는 실패하고 있어, 에러의 원인에 관한 상세가 서버로부터 제공되고 있는 일도 있습니다.

SortControl 코딩예는 이 클래스의 사용 방법을 나타내고 있습니다.

이 클래스는 RFC 2891 으로 정의되고 있는 서버측에서의 소트의 LDAPv3 응답 컨트롤을 구현합니다.이 컨트롤의 값의 ASN. 1 정의는 다음과 같습니다.

     SortResult ::= SEQUENCE {
        sortResult  ENUMERATED {
            success                   (0), -- results are sorted
            operationsError           (1), -- server internal failure
            timeLimitExceeded         (3), -- timelimit reached before
                                           -- sorting was completed
            strongAuthRequired        (8), -- refused to return sorted
                                           -- results via insecure
                                           -- protocol
            adminLimitExceeded       (11), -- too many matching entries
                                           -- for the server to sort
            noSuchAttribute          (16), -- unrecognized attribute
                                           -- type in sort key
            inappropriateMatching    (18), -- unrecognized or inappro-
                                           -- priate matching rule in
                                           -- sort key
            insufficientAccessRights (50), -- refused to return sorted
                                           -- results to this client
            busy                     (51), -- too busy to process
            unwillingToPerform       (53), -- unable to sort
            other                    (80)
            },
      attributeType [0] AttributeType OPTIONAL }

 

도입된 버전 :

1.5

관련 항목:

SortControl, 직렬화 된 형식

필드 개요

static String

OID 서버측에서의 소트의 응답 컨트롤에 할당할 수 있는 객체 식별자는 1.2. 840.113556. 1.4. 474 입니다.

클래스 javax.naming.ldap. BasicControl 로부터 상속된 필드

criticality, id, value

인터페이스 javax.naming.ldap. Control 로부터 상속된 필드

CRITICAL, NONCRITICAL

생성자 개요

SortResponseControl (String id, boolean criticality, byte[] value)
소트 요구의 결과를 나타내기 위한 컨트롤을 구축합니다.

메서드 개요

String	getAttributeID () 소트 실패의 원인이 된 속성의 ID를 취득합니다.
NamingException	getException () 결과 코드에 적절한 NamingException을 취득합니다.
int	getResultCode () 소트 조작의 LDAP 결과 코드를 취득합니다.
boolean	isSorted () 검색 결과가 정상적으로 소트 되고 있는지를 판정합니다.

클래스 javax.naming.ldap. BasicControl 로부터 상속된 메서드

getEncodedValue, getID, isCritical

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

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

필드의 상세

OID

public static final String  OID

서버측에서의 소트의 응답 컨트롤에 할당할 수 있는 객체 식별자는 1.2. 840.113556. 1.4. 474 입니다.

관련 항목:

정수 필드값

생성자 상세

SortResponseControl

public SortResponseControl(String  id,
                           boolean criticality,
                           byte[] value)
                    throws IOException 

소트 요구의 결과를 나타내기 위한 컨트롤을 구축합니다.

파라미터:

id - 컨트롤의 객체 식별자의 캐릭터 라인

criticality - 컨트롤의 위기의 정도

value - 컨트롤의 ASN. 1 BER 로 encode 된 값. 이 값은 복제되지 않기 때문에 이 값을 변경하면 컨트롤의 내용에 영향을 준다

예외:

IOException - 컨트롤의 값을 복호화 할 경우에 에러가 발생했을 경우

메서드의 상세

isSorted

public boolean isSorted()

검색 결과가 정상적으로 소트 되고 있는지를 판정합니다. 소트중에 에러가 발생했을 경우는 NamingException가 발생 됩니다.

반환값:

검색 결과가 소트 되고 있는 경우는 true

getResultCode

public int getResultCode()

소트 조작의 LDAP 결과 코드를 취득합니다.

반환값:

결과 코드. 값 0 은 성공을 나타낸다

getAttributeID

public String  getAttributeID()

소트 실패의 원인이 된 속성의 ID를 취득합니다. 서버로부터 ID가 돌려주고지지 않았던 경우는 null을 리턴합니다.

반환값:

원인이 된 속성의 ID. null인 경우도 있다

getException

public NamingException  getException()

결과 코드에 적절한 NamingException을 취득합니다.

반환값:

NamingException. 결과 코드가 성공을 나타내고 있는 경우는 null