001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * https://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 021package org.apache.directory.api.dsmlv2.response; 022 023 024import org.apache.directory.api.ldap.codec.api.LdapApiService; 025import org.apache.directory.api.ldap.model.message.CompareResponse; 026import org.apache.directory.api.ldap.model.message.CompareResponseImpl; 027import org.apache.directory.api.ldap.model.message.MessageTypeEnum; 028import org.dom4j.Element; 029import org.dom4j.tree.DefaultElement; 030 031 032/** 033 * DSML Decorator for CompareResponse 034 * 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 */ 037public class CompareResponseDsml extends AbstractResultResponseDsml<CompareResponse> implements CompareResponse 038{ 039 private static final String COMPARE_RESPONSE_TAG = "compareResponse"; 040 041 042 /** 043 * Creates a new getDecoratedMessage() of CompareResponseDsml. 044 * 045 * @param codec The LDAP Service to use 046 */ 047 public CompareResponseDsml( LdapApiService codec ) 048 { 049 super( codec, new CompareResponseImpl() ); 050 } 051 052 053 /** 054 * Creates a new getDecoratedMessage() of CompareResponseDsml. 055 * 056 * @param codec The LDAP Service to use 057 * @param ldapMessage the message to decorate 058 */ 059 public CompareResponseDsml( LdapApiService codec, CompareResponse ldapMessage ) 060 { 061 super( codec, ldapMessage ); 062 } 063 064 065 /** 066 * {@inheritDoc} 067 */ 068 @Override 069 public MessageTypeEnum getType() 070 { 071 return getDecorated().getType(); 072 } 073 074 075 /** 076 * {@inheritDoc} 077 */ 078 @Override 079 public Element toDsml( Element root ) 080 { 081 Element element; 082 083 if ( root != null ) 084 { 085 element = root.addElement( COMPARE_RESPONSE_TAG ); 086 } 087 else 088 { 089 element = new DefaultElement( COMPARE_RESPONSE_TAG ); 090 } 091 092 LdapResultDsml ldapResultDsml = new LdapResultDsml( getCodecService(), 093 getDecorated().getLdapResult(), getDecorated() ); 094 ldapResultDsml.toDsml( element ); 095 return element; 096 } 097 098 099 /** 100 * {@inheritDoc} 101 */ 102 @Override 103 public boolean isTrue() 104 { 105 return getDecorated().isTrue(); 106 } 107}