com.amazonaws.athena.connector.lambda.serde.FederatedIdentitySerDe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-athena-federation-sdk Show documentation

The Athena Query Federation SDK defines a set of interfaces and wire protocols that you can implement to enable Athena to delegate portions of it's query execution plan to code that you deploy/write.

There is a newer version: 2024.46.1

Show newest version

/*-
 * #%L
 * Amazon Athena Query Federation SDK
 * %%
 * Copyright (C) 2019 - 2020 Amazon Web Services
 * %%
 * Licensed 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
 * 
 *      http://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.
 * #L%
 */
package com.amazonaws.athena.connector.lambda.serde;

import com.amazonaws.athena.connector.lambda.security.FederatedIdentity;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.SerializerProvider;

import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
 * Since this SerDe is used in {@link PingRequestSerDe} it needs to be forwards compatible.
 */
public final class FederatedIdentitySerDe
{
    private static final String ID_FIELD = "id";
    private static final String COMPATIBILITY_ID = "UNKNOWN";
    private static final String PRINCIPAL_FIELD = "principal";
    private static final String COMPATIBILITY_PRINCIPAL = "UNKNOWN";
    private static final String ACCOUNT_FIELD = "account";
    private static final String ARN_FIELD = "arn";
    private static final String TAGS_FIELD = "tags";
    private static final String GROUPS_FIELD = "groups";
    // new fields should only be appended to the end for forwards compatibility

    private FederatedIdentitySerDe() {}

    public static final class Serializer extends BaseSerializer
    {
        public Serializer()
        {
            super(FederatedIdentity.class);
        }

        @Override
        public void doSerialize(FederatedIdentity federatedIdentity, JsonGenerator jgen, SerializerProvider provider)
                throws IOException
        {
            jgen.writeStringField(ID_FIELD, COMPATIBILITY_ID);
            jgen.writeStringField(PRINCIPAL_FIELD, COMPATIBILITY_PRINCIPAL);
            jgen.writeStringField(ACCOUNT_FIELD, federatedIdentity.getAccount());
            jgen.writeStringField(ARN_FIELD, federatedIdentity.getArn());
            writeStringMap(jgen, TAGS_FIELD, federatedIdentity.getPrincipalTags());
            writeStringArray(jgen, GROUPS_FIELD, federatedIdentity.getIamGroups());
            // new fields should only be appended to the end for backwards and forwards compatibility
        }
    }

    public static final class Deserializer extends BaseDeserializer
    {
        public Deserializer()
        {
            super(FederatedIdentity.class);
        }

        @Override
        public FederatedIdentity deserialize(JsonParser jparser, DeserializationContext ctxt)
                throws IOException
        {
            if (jparser.nextToken() != JsonToken.VALUE_NULL) {
                validateObjectStart(jparser.getCurrentToken());
                FederatedIdentity federatedIdentity = doDeserialize(jparser, ctxt);

                // consume unknown tokens to allow forwards compatibility
                ignoreRestOfObject(jparser);
                return federatedIdentity;
            }

            return null;
        }

        @Override
        public FederatedIdentity doDeserialize(JsonParser jparser, DeserializationContext ctxt)
                throws IOException
        {
            // First, read fields that we no longer care about.
            getNextStringField(jparser, ID_FIELD);
            getNextStringField(jparser, PRINCIPAL_FIELD);

            String account = getNextStringField(jparser, ACCOUNT_FIELD);
            String arn = getNextStringField(jparser, ARN_FIELD);
            Map principalTags = getNextStringMap(jparser, TAGS_FIELD);
            List groups = getNextStringArray(jparser, GROUPS_FIELD);

            return new FederatedIdentity(arn, account, principalTags, groups);
        }
    }
}