org.apache.camel.component.file.azure.FilesToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-azure-files Show documentation
Camel Azure Files Component
The newest version!
/*
 * 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
 *
 *      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.
 */
package org.apache.camel.component.file.azure;

import java.net.URISyntaxException;
import java.util.Objects;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriParams;

/**
 * Azure Files account or service SAS token.
 * 
 * The user delegation SAS token is not specified for Azure Files.
 *
 * @see com.azure.storage.common.implementation.Constants.UrlConstants
 * @see Azure account SAS
 * @see Azure service SAS
 */
@UriParams
final class FilesToken {

    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String sv;
    @UriParam(label = "security", description = "part of account SAS token", secret = true)
    private String ss;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String srt;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String sp;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String se;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String st;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String spr;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String sig;
    @UriParam(label = "security", description = "part of service SAS token", secret = true)
    private String si;
    @UriParam(label = "security", description = "part of service SAS token", secret = true)
    private String sr;
    @UriParam(label = "security", description = "part of service SAS token", secret = true)
    private String sdd;
    @UriParam(label = "security", description = "part of SAS token", secret = true)
    private String sip;

    public void setSv(String sv) {
        this.sv = sv;
    }

    public void setSs(String ss) {
        this.ss = ss;
    }

    public void setSrt(String srt) {
        this.srt = srt;
    }

    public void setSp(String sp) {
        this.sp = sp;
    }

    public void setSe(String se) {
        this.se = se;
    }

    public void setSt(String st) {
        this.st = st;
    }

    public void setSpr(String spr) {
        this.spr = spr;
    }

    public void setSig(String sig) {
        this.sig = sig;
    }

    public void setSi(String si) {
        this.si = si;
    }

    public void setSr(String sr) {
        this.sr = sr;
    }

    public void setSdd(String sdd) {
        this.sdd = sdd;
    }

    public void setSip(String sip) {
        this.sip = sip;
    }

    boolean isInvalid() {
        return sig == null || sv == null || se == null || !(isAccountTokenForFilesService() || isFilesServiceToken());
    }

    private boolean isAccountTokenForFilesService() {
        return ss != null && ss.contains("f");
    }

    private boolean isFilesServiceToken() {
        return sr != null && (sr.contains("f") || sr.contains("s"));
    }

    // sv=2021-12-02&ss=f&srt=o&sp=rwdlc&se=2023-05-05T19:27:05Z&st=2023-04-28T11:27:05Z&spr=https&sig=TCU0PcBjrxRbKOW%2FLA7HrPLISin6FXLNkRtLvmxkvhY%3D"
    // params in Azure order
    public String toURIQuery() {
        try {
            return Stream
                    .of(e("sv", sv), e("ss", ss), e("srt", srt), e("sp", sp), e("se", se), e("st", st),
                            e("spr", spr), e("sig", sig), e("si", si), e("sr", sr), e("sdd", sdd), e("sip", sip))
                    .filter(Objects::nonNull)
                    .collect(Collectors.joining("&"));
        } catch (URISyntaxException e) {
            return null;
        }
    }

    private String e(String param, String value) throws URISyntaxException {
        if (value == null || value.isBlank()) {
            return null;
        }
        return param + "=" + FilesURIStrings.encodeTokenValue(value);
    }

    @Override
    public int hashCode() {
        return Objects.hash(sdd, se, si, sig, sip, sp, spr, sr, srt, ss, st, sv);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        FilesToken other = (FilesToken) obj;
        return Objects.equals(sdd, other.sdd) && Objects.equals(se, other.se)
                && Objects.equals(si, other.si) && Objects.equals(sig, other.sig)
                && Objects.equals(sip, other.sip) && Objects.equals(sp, other.sp)
                && Objects.equals(spr, other.spr) && Objects.equals(sr, other.sr)
                && Objects.equals(srt, other.srt) && Objects.equals(ss, other.ss)
                && Objects.equals(st, other.st) && Objects.equals(sv, other.sv);
    }

    String getSv() {
        return sv;
    }

    String getSs() {
        return ss;
    }

    String getSrt() {
        return srt;
    }

    String getSp() {
        return sp;
    }

    String getSe() {
        return se;
    }

    String getSt() {
        return st;
    }

    String getSpr() {
        return spr;
    }

    String getSig() {
        return sig;
    }

    String getSi() {
        return si;
    }

    String getSr() {
        return sr;
    }

    String getSdd() {
        return sdd;
    }

    String getSip() {
        return sip;
    }

}