24.3. 코드에 주석 달기

@WSDL설명서 주석은 org.apache.cxf.annotations.WSDL설명서 인터페이스로 정의됩니다. SEI 또는 SEI 방법에 배치할 수 있습니다.

이 주석을 사용하면 SEI가 WSDL로 변환된 후 wsdl:documentation 요소에 표시되는 문서를 추가할 수 있습니다. 기본적으로 문서 요소는 포트 유형 내에 표시되지만 배치 속성을 지정하여 문서가 WSDL 파일의 다른 위치에 표시되도록 할 수 있습니다. 24.3.4.2절. “@WSDL설명서 속성” @WSDL설명서 주석에서 지원하는 속성을 표시합니다.

@WSDLDocumentationCollection 주석은 org.apache.cxf.annotations.WSDLDocumentationCollection 인터페이스에 의해 정의됩니다. SEI 또는 SEI 방법에 배치할 수 있습니다.

이 주석은 단일 배치 위치 또는 다양한 배치 위치에 여러 문서 요소를 삽입하는 데 사용됩니다.

WSDL 계약에 문서가 표시되는 위치를 지정하려면 WSDL설명서.Placement 유형의 배치 속성을 지정할 수 있습니다. 배치에는 다음 값 중 하나가 있을 수 있습니다.

24.3.4.3절. “@WSDL설명서 사용” SEI 및 해당 메서드 중 하나에 @WSDL설명서 주석을 추가하는 방법을 보여줍니다.

24.3.4.5절. “@WSDLDocumentationCollection 사용” SEI에 @WSDLDocumentationCollection 주석을 추가하는 방법을 보여줍니다.

@SchemaValidation 주석은 org.apache.cxf.annotations.SchemaValidation 인터페이스에서 정의됩니다. SEI 및 개별 SEI 방법에 배치 할 수 있습니다.

이 주석은 이 엔드포인트로 전송된 XML 메시지의 스키마 유효성 검사를 켜집니다. 이 기능은 들어오는 XML 메시지의 형식에 문제가 있다고 의심되는 경우 테스트 목적에 유용할 수 있습니다. 기본적으로 검증은 성능에 상당한 영향을 미치기 때문에 비활성화되어 있습니다.

스키마 유효성 검사 동작은 type 매개 변수에 의해 제어되며, 해당 값은 org.apache.cxf.annotations.SchemaValidation.SchemaValidationType 유형의 열거입니다. 24.3.4.7절. “스키마 유효성 검사 유형 값” 사용 가능한 검증 유형 목록을 표시합니다.

다음 예제에서는 MyService SEI를 기반으로 끝점에 대한 메시지의 스키마 유효성 검사를 활성화하는 방법을 보여줍니다. 주석을 SEI 전체 및 SEI의 개별 메서드에 어떻게 적용할 수 있는지 확인합니다.

@WebService
@SchemaValidation(type = SchemaValidationType.BOTH)
public interface MyService {
    Foo validateBoth(Bar data);

    @SchemaValidation(type = SchemaValidationType.NONE)
    Foo validateNone(Bar data);

    @SchemaValidation(type = SchemaValidationType.IN)
    Foo validateIn(Bar data);

    @SchemaValidation(type = SchemaValidationType.OUT)
    Foo validateOut(Bar data);

    @SchemaValidation(type = SchemaValidationType.REQUEST)
    Foo validateRequest(Bar data);

    @SchemaValidation(type = SchemaValidationType.RESPONSE)
    Foo validateResponse(Bar data);
}

@DataBinding 주석은 org.apache.cxf.annotations.DataBinding 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

이 주석은 데이터 바인딩을 SEI와 연결하는 데 사용되며 기본 CryostatB 데이터 바인딩을 대체합니다. @DataBinding 주석의 값은 데이터 바인딩 ClassName.class를 제공하는 클래스 여야 합니다.

현재 Apache CXF에서 지원하는 데이터 바인딩은 다음과 같습니다.

24.3.4.9절. “데이터 바인딩 설정” SDO 바인딩을 HelloWorld SEI와 연결하는 방법 표시

@GZIP 주석은 org.apache.cxf.annotations.GZIP 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

메시지의 GZIP 압축을 활성화합니다. GZIP는 협상된 개선 사항입니다. 즉, 클라이언트의 초기 요청이 압축되지 않지만 Accept 헤더가 추가되고 서버가 GZIP 압축을 지원하는 경우 응답이 압축되고 후속 요청도 발생합니다.

24.3.4.11절. “@GZIP 속성” @GZIP 주석에서 지원하는 선택적 속성을 표시합니다.

@FastInfoset 주석은 org.apache.cxf.annotations.FastInfoset 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

메시지에 FastInfoset 형식을 사용할 수 있습니다. FastInfoset은 XML의 바이너리 인코딩 형식이며 메시지 크기와 XML 메시지의 처리 성능을 모두 최적화하는 것을 목표로 합니다. 자세한 내용은 Fast Infoset 의 다음 Sun 문서를 참조하십시오.

FastInfoset은 협상된 개선 사항입니다. 즉, 클라이언트의 초기 요청은 FastInfoset 형식이 아니지만 Accept 헤더가 추가되고 서버가 FastInfoset을 지원하는 경우 응답이 FastInfoset에 있고 후속 요청도 발생합니다.

24.3.4.12절. “@FastInfoset Properties” @FastInfoset 주석에서 지원하는 선택적 속성을 표시합니다.

24.3.4.13절. “GZIP 활성화” HelloWorld SEI에 대해 GZIP 압축을 활성화하는 방법을 보여줍니다.

24.3.4.14절. “FastInfoset 활성화” HelloWorld SEI에 대해 FastInfoset 형식을 활성화하는 방법을 보여줍니다.

@Logging 주석은 org.apache.cxf.annotations.Logging 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

이 주석은 SEI와 연결된 모든 끝점에 로깅할 수 있습니다. 24.3.4.16절. “@logging 속성” 이 주석에서 설정할 수 있는 선택적 속성을 표시합니다.

24.3.4.17절. “주석을 사용하여 로깅 구성” HelloWorld SEI에 대한 로깅을 활성화하는 방법을 보여줍니다. 여기서 들어오는 메시지가 < stdout >으로 전송되고 발신 메시지가 < logger >로 전송됩니다.

@EndpointProperty 주석은 org.apache.cxf.annotations.EndpointProperty 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

이 주석은 Apache CXF별 구성 설정을 엔드포인트에 추가합니다. 끝점 속성은 Spring 구성 파일에 지정할 수도 있습니다. 예를 들어 엔드포인트에서 WS-Security를 구성하려면 다음과 같이 Spring 구성 파일에서 jaxws:properties 요소를 사용하여 엔드포인트 속성을 추가할 수 있습니다.

<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jaxws="http://cxf.apache.org/jaxws"
   ... >

   <jaxws:endpoint
      id="MyService"
      address="https://localhost:9001/MyService"
      serviceName="interop:MyService"
      endpointName="interop:MyServiceEndpoint"
      implementor="com.foo.MyService">

      <jaxws:properties>
         <entry key="ws-security.callback-handler" value="interop.client.UTPasswordCallback"/>
         <entry key="ws-security.signature.properties" value="etc/keystore.properties"/>
         <entry key="ws-security.encryption.properties" value="etc/truststore.properties"/>
         <entry key="ws-security.encryption.username" value="useReqSigCert"/>
      </jaxws:properties>

   </jaxws:endpoint>
</beans>

또는 24.3.4.20절. “@EndpointProperty 주석을 사용하여 WS-Security 구성” 에 표시된 대로 @EndpointProperty 주석을 SEI에 추가하여 Java에서 이전 구성 설정을 지정할 수 있습니다.

@EndpointProperties 주석은 org.apache.cxf.annotations.EndpointProperties 인터페이스에서 정의합니다. 이는 SEI에 배치됩니다.

이 주석은 여러 개의 @EndpointProperty 주석을 목록으로 그룹화하는 방법을 제공합니다. @EndpointProperties 를 사용하면 24.3.4.20절. “@EndpointProperty 주석을 사용하여 WS-Security 구성” 에 표시된 대로 24.3.4.21절. “@EndpointProperties 주석을 사용하여 WS-Security 구성” 를 다시 작성할 수 있습니다.

@Policy 주석은 org.apache.cxf.annotations.Policy 인터페이스에서 정의합니다. SEI 또는 SEI 방법에 배치할 수 있습니다.

이 주석은 WSDL 정책을 SEI 또는 SEI 메서드와 연결하는 데 사용됩니다. 정책은 표준 wsdl:policy 요소가 포함된 XML 파일을 참조하는 URI를 제공하여 지정합니다. WSDL 계약이 SEI(예: java2ws 명령줄 도구 사용)에서 생성되는 경우 이 정책을 WSDL에 포함할지 여부를 지정할 수 있습니다.

24.3.4.23절. “@policy 속성” @Policy 주석에서 지원하는 속성을 표시합니다.

@Policies 주석은 org.apache.cxf.annotations.Policies 인터페이스에서 정의합니다. SEI 또는 SEI 방법에 배치 할 수 있습니다.

이 주석은 여러 개의 @Policy 주석을 목록으로 그룹화하는 방법을 제공합니다.

WSDL 계약에 정책이 표시되는 위치를 지정하려면 Policy.Placement 유형인 placement 속성을 지정할 수 있습니다. 배치에는 다음 값 중 하나가 있을 수 있습니다.

Policy.Placement.BINDING
Policy.Placement.BINDING_OPERATION
Policy.Placement.BINDING_OPERATION_FAULT
Policy.Placement.BINDING_OPERATION_INPUT
Policy.Placement.BINDING_OPERATION_OUTPUT
Policy.Placement.DEFAULT
Policy.Placement.PORT_TYPE
Policy.Placement.PORT_TYPE_OPERATION
Policy.Placement.PORT_TYPE_OPERATION_FAULT
Policy.Placement.PORT_TYPE_OPERATION_INPUT
Policy.Placement.PORT_TYPE_OPERATION_OUTPUT
Policy.Placement.SERVICE
Policy.Placement.SERVICE_PORT

다음 예제에서는 WSDL 정책을 HelloWorld SEI와 연결하는 방법과 정책을 sayHi 방법과 연결하는 방법을 보여줍니다. 정책 자체는 주석policies 디렉터리의 파일 시스템의 XML 파일에 저장됩니다.

@WebService
@Policy(uri = "annotationpolicies/TestImplPolicy.xml",
        placement = Policy.Placement.SERVICE_PORT),
@Policy(uri = "annotationpolicies/TestPortTypePolicy.xml",
        placement = Policy.Placement.PORT_TYPE)
public interface HelloWorld {
    @Policy(uri = "annotationpolicies/TestOperationPTPolicy.xml",
            placement = Policy.Placement.PORT_TYPE_OPERATION),
    String sayHi(@WebParam(name = "text") String text);
}

다음 예와 같이 @Policies 주석을 사용하여 여러 @Policy 주석을 목록으로 그룹화할 수 있습니다.

@WebService
@Policies({
    @Policy(uri = "annotationpolicies/TestImplPolicy.xml",
            placement = Policy.Placement.SERVICE_PORT),
    @Policy(uri = "annotationpolicies/TestPortTypePolicy.xml",
            placement = Policy.Placement.PORT_TYPE)
})
public interface HelloWorld {
    @Policy(uri = "annotationpolicies/TestOperationPTPolicy.xml",
            placement = Policy.Placement.PORT_TYPE_OPERATION),
    String sayHi(@WebParam(name = "text") String text);
}