| /** |
| * 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 |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * 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.hadoop.ozone.om.protocol; |
| |
| import org.apache.hadoop.io.Text; |
| import org.apache.hadoop.io.retry.Idempotent; |
| import org.apache.hadoop.ozone.om.OMConfigKeys; |
| import org.apache.hadoop.ozone.security.OzoneTokenIdentifier; |
| import org.apache.hadoop.security.KerberosInfo; |
| import org.apache.hadoop.security.token.Token; |
| import org.apache.hadoop.ozone.om.exceptions.OMException; |
| |
| /** |
| * Security protocol for a secure OzoneManager. |
| */ |
| @KerberosInfo( |
| serverPrincipal = OMConfigKeys.OZONE_OM_KERBEROS_PRINCIPAL_KEY) |
| public interface OzoneManagerSecurityProtocol { |
| |
| /** |
| * Get a valid Delegation Token. |
| * |
| * @param renewer the designated renewer for the token |
| * @return Token<OzoneDelegationTokenSelector> |
| * @throws OMException |
| */ |
| @Idempotent |
| Token<OzoneTokenIdentifier> getDelegationToken(Text renewer) |
| throws OMException; |
| |
| /** |
| * Renew an existing delegation token. |
| * |
| * @param token delegation token obtained earlier |
| * @return the new expiration time |
| * @throws OMException |
| */ |
| @Idempotent |
| long renewDelegationToken(Token<OzoneTokenIdentifier> token) |
| throws OMException; |
| |
| /** |
| * Cancel an existing delegation token. |
| * |
| * @param token delegation token |
| * @throws OMException |
| */ |
| @Idempotent |
| void cancelDelegationToken(Token<OzoneTokenIdentifier> token) |
| throws OMException; |
| |
| } |