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 * http://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 */ 020package org.apache.directory.api.ldap.extras.extended.whoAmI; 021 022 023import org.apache.directory.api.ldap.model.message.ExtendedResponse; 024import org.apache.directory.api.ldap.model.name.Dn; 025 026 027/** 028 * The RFC 4532 WhoAmI response : 029 * 030 * <pre> 031 * authzid ::= OCTET STRING OPTIONAL 032 * </pre> 033 * 034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 035 */ 036public interface WhoAmIResponse extends ExtendedResponse 037{ 038 /** The OID for the WhoAmI extended operation response. */ 039 String EXTENSION_OID = WhoAmIRequest.EXTENSION_OID; 040 041 042 /** 043 * @return true if the response contains a DN authz (dn:XXX) 044 */ 045 boolean isDnAuthzId(); 046 047 048 /** 049 * @return true if the response contains a userID authz (u:XXX) 050 */ 051 boolean isUserAuthzId(); 052 053 054 /** 055 * Get the authzid as a byte[] 056 * 057 * @return The authzid or null 058 */ 059 byte[] getAuthzId(); 060 061 062 /** 063 * Get the authzid as String. We will strip out the 'dn:' or 'u:' part. 064 * 065 * @return The authzid or null 066 */ 067 String getAuthzIdString(); 068 069 070 /** 071 * Get the UserId 072 * 073 * @return The userId or null 074 */ 075 String getUserId(); 076 077 078 /** 079 * Get the DN authzid. 080 * 081 * @return The DN or null 082 */ 083 Dn getDn(); 084 085 086 /** 087 * set the authzid 088 * 089 * @param authzId The authzId to set 090 */ 091 void setAuthzId( byte[] authzId ); 092}