001    /*
002     * Copyright 2011-2012 UnboundID Corp.
003     *
004     * This program is free software; you can redistribute it and/or modify
005     * it under the terms of the GNU General Public License (GPLv2 only)
006     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
007     * as published by the Free Software Foundation.
008     *
009     * This program is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012     * GNU General Public License for more details.
013     *
014     * You should have received a copy of the GNU General Public License
015     * along with this program; if not, see <http://www.gnu.org/licenses>.
016     */
017    
018    package com.unboundid.scim.sdk;
019    
020    import com.unboundid.scim.schema.ResourceDescriptor;
021    
022    import java.net.URI;
023    
024    
025    
026    /**
027     * This class represents a SCIM Get Resource request to retrieve all or
028     * selected attributes from a single resource.
029     */
030    public final class GetResourceRequest extends ResourceReturningRequest
031    {
032      /**
033       * The requested resource ID.
034       */
035      private final String resourceID;
036    
037    
038    
039      /**
040       * Create a new SCIM Get Resource request from the provided information.
041       *
042       * @param baseURL              The base URL for the SCIM service.
043       * @param authenticatedUserID  The authenticated user name or {@code null} if
044       *                             the request is not authenticated.
045       * @param resourceDescriptor   The ResourceDescriptor associated with this
046       *                             request.
047       * @param resourceID           The requested resource ID.
048       * @param attributes           The set of requested attributes.
049       */
050      public GetResourceRequest(final URI baseURL,
051                                final String authenticatedUserID,
052                                final ResourceDescriptor resourceDescriptor,
053                                final String resourceID,
054                                final SCIMQueryAttributes attributes)
055      {
056        super(baseURL, authenticatedUserID, resourceDescriptor, attributes);
057        this.resourceID          = resourceID;
058      }
059    
060    
061    
062      /**
063       * Get the requested resource ID.
064       *
065       * @return  The requested resource ID.
066       */
067      public String getResourceID()
068      {
069        return resourceID;
070      }
071    }