src/main/java/org/apache/sling/models/impl/via/OriginalResourceViaProvider.java

/*
 * 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.sling.models.impl.via;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.ViaProviderType;
import org.apache.sling.models.annotations.via.OriginalResource;
import org.apache.sling.models.spi.ViaProvider;
import org.osgi.service.component.annotations.Component;

/**
 * This {@link ViaProvider} implements the counterpart of the {@link ForcedResourceTypeViaProvider} and
 * {@link ResourceSuperTypeViaProvider}. It is in particular helpful in models that want to inject another model using the original
 * {@link Resource}'s or {@link SlingHttpServletRequest}'s resource type instead of the one forced by either of the above-mentioned via
 * providers.
 * <p>
 * The implementation simply unwraps the {@link org.apache.sling.api.resource.ResourceWrapper} or
 * {@link org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper} used by the {@link ForcedResourceTypeViaProvider} and
 * {@link ResourceSuperTypeViaProvider}.
 */
@Component
public class OriginalResourceViaProvider implements ViaProvider {

    @Override
    public Class<? extends ViaProviderType> getType() {
        return OriginalResource.class;
    }

    @Override
    public Object getAdaptable(Object original, String value) {
        if (original instanceof SlingHttpServletRequest) {
            SlingHttpServletRequest originalRequest = (SlingHttpServletRequest) original;
            while (originalRequest instanceof ResourceTypeForcingRequestWrapper) {
                originalRequest = ((ResourceTypeForcingRequestWrapper) originalRequest).getSlingRequest();
            }
            return originalRequest;
        } else if (original instanceof Resource) {
            Resource originalResource = (Resource) original;
            while (originalResource instanceof ResourceTypeForcingResourceWrapper) {
                originalResource = ((ResourceTypeForcingResourceWrapper) originalResource).getResource();
            }
            return originalResource;
        } else {
            return null;
        }
    }
}