AbstractX509KeyIdentifierQuery.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.crypto.store.wiki.internal.query;

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

import org.xwiki.crypto.BinaryStringEncoder;
import org.xwiki.crypto.store.CertificateStoreException;
import org.xwiki.crypto.store.wiki.internal.X509CertificateWikiStore;
import org.xwiki.model.reference.EntityReference;
import org.xwiki.model.reference.EntityReferenceSerializer;
import org.xwiki.query.QueryException;
import org.xwiki.query.QueryManager;

/**
 * Abstract class to build queries on CertificateClass in a certificate store based on subject key identifier.
 *
 * @version $Id: 9da8b529176ac5aca42777b1e333969e643920fe $
 * @since 6.1M2
 */
public abstract class AbstractX509KeyIdentifierQuery extends AbstractX509StoreQuery
{
    private static final String KEYID = "keyid";

    private static final String WHERE_STATEMENT =
        " and obj." + X509CertificateWikiStore.CERTIFICATECLASS_PROP_KEYID + "=:" + KEYID;

    /**
     * Create a query.
     *
     * @param store the reference of a document or a space where the certificate should be stored.
     * @param select the select statement specific to the query.
     * @param from the additional from statement specific to the query.
     * @param where the additional where statement specific to the query.
     * @param encoder a string encoder/decoder used to convert byte arrays to/from String.
     * @param queryManager the query manager used to build queries.
     * @param serializer the entity reference serializer to serialize the store reference for query
     * @throws CertificateStoreException on error creating required queries.
     */
    public AbstractX509KeyIdentifierQuery(EntityReference store, String select, String from, String where,
        BinaryStringEncoder encoder, QueryManager queryManager, EntityReferenceSerializer<String>serializer)
        throws CertificateStoreException
    {
        super(store, select, from, WHERE_STATEMENT + where, encoder, queryManager, serializer);
    }

    /**
     * Execute the query.
     *
     * @param keyId the subject key identifier.
     * @return the query result.
     * @throws IOException on encoding error.
     * @throws QueryException on query error.
     */
    protected <T> List<T> execute(byte[] keyId) throws IOException, QueryException
    {
        return getQuery().bindValue(KEYID, getEncoder().encode(keyId)).execute();
    }

}