| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * https://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| package org.apache.directory.api.ldap.model.message; |
| |
| |
| /** |
| * An Abstract ExtendedResponse implementation. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public abstract class AbstractExtendedResponse extends AbstractResultResponse implements ExtendedResponse |
| { |
| static final long serialVersionUID = -6646752766410531060L; |
| |
| /** Object identifier for the extended response */ |
| protected String responseName; |
| |
| /** Extended response message type enumeration value */ |
| private static final MessageTypeEnum TYPE = MessageTypeEnum.EXTENDED_RESPONSE; |
| |
| /** |
| * Creates an ExtendedResponse as a reply to an ExtendedRequest. |
| * |
| * @param responseName the ExtendedResponse's name |
| */ |
| public AbstractExtendedResponse( String responseName ) |
| { |
| super( -1, TYPE ); |
| this.responseName = responseName; |
| } |
| |
| |
| /** |
| * Creates an ExtendedResponse as a reply to an ExtendedRequest. |
| * |
| * @param id the session unique message id |
| * @param responseName the ExtendedResponse's name |
| */ |
| public AbstractExtendedResponse( final int id, String responseName ) |
| { |
| super( id, TYPE ); |
| this.responseName = responseName; |
| } |
| |
| |
| /** |
| * Creates an ExtendedResponse as a reply to an ExtendedRequest. |
| * |
| * @param id the session unique message id |
| */ |
| public AbstractExtendedResponse( int id ) |
| { |
| super( id, TYPE ); |
| } |
| |
| |
| // ------------------------------------------------------------------------ |
| // ExtendedResponse Interface Method Implementations |
| // ------------------------------------------------------------------------ |
| |
| /** |
| * Gets the OID uniquely identifying this extended response (a.k.a. its |
| * name). |
| * |
| * @return the responseName of the extended response |
| */ |
| @Override |
| public String getResponseName() |
| { |
| return ( responseName == null ) ? "" : responseName; |
| } |
| |
| |
| /** |
| * Sets the OID uniquely identifying this extended response (a.k.a. its |
| * name). |
| * |
| * @param responseName the OID of the extended response type. |
| */ |
| @Override |
| public void setResponseName( String responseName ) |
| { |
| this.responseName = responseName; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public int hashCode() |
| { |
| int hash = 37; |
| |
| if ( responseName != null ) |
| { |
| hash = hash * 17 + responseName.hashCode(); |
| } |
| |
| hash = hash * 17 + super.hashCode(); |
| |
| return hash; |
| } |
| |
| |
| /** |
| * Checks to see if an object equals this ExtendedRequest. |
| * |
| * @param obj |
| * the object to be checked for equality |
| * @return true if the obj equals this ExtendedRequest, false otherwise |
| */ |
| @Override |
| public boolean equals( Object obj ) |
| { |
| if ( obj == this ) |
| { |
| return true; |
| } |
| |
| if ( !super.equals( obj ) ) |
| { |
| return false; |
| } |
| |
| if ( !( obj instanceof ExtendedResponse ) ) |
| { |
| return false; |
| } |
| |
| ExtendedResponse resp = ( ExtendedResponse ) obj; |
| |
| if ( ( responseName != null ) && ( resp.getResponseName() == null ) ) |
| { |
| return false; |
| } |
| |
| if ( ( responseName == null ) && ( resp.getResponseName() != null ) ) |
| { |
| return false; |
| } |
| |
| if ( ( responseName != null ) && ( resp.getResponseName() != null ) |
| && !responseName.equals( resp.getResponseName() ) ) |
| { |
| return false; |
| } |
| |
| return true; |
| } |
| |
| |
| /** |
| * Get a String representation of an ExtendedResponse |
| * |
| * @return An ExtendedResponse String |
| */ |
| @Override |
| public String toString() |
| { |
| StringBuilder sb = new StringBuilder(); |
| |
| sb.append( " Extended Response\n" ); |
| |
| if ( responseName != null ) |
| { |
| sb.append( " ResponseName :'" ).append( responseName ).append( "'\n" ); |
| } |
| |
| sb.append( super.toString() ); |
| |
| return super.toString( sb.toString() ); |
| } |
| } |