Lots of code cleanup
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / saml2 / ArtifactResolution.java
index 61b80d1..359fee3 100644 (file)
@@ -36,7 +36,6 @@ import org.opensaml.saml2.metadata.Endpoint;
 import org.opensaml.saml2.metadata.EntityDescriptor;
 import org.opensaml.saml2.metadata.SPSSODescriptor;
 import org.opensaml.saml2.metadata.provider.MetadataProvider;
-import org.opensaml.saml2.metadata.provider.MetadataProviderException;
 import org.opensaml.ws.message.decoder.MessageDecodingException;
 import org.opensaml.ws.transport.http.HTTPInTransport;
 import org.opensaml.ws.transport.http.HTTPOutTransport;
@@ -45,7 +44,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
-import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
+import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.ArtifactResolutionConfiguration;
 
 /**
@@ -83,7 +82,7 @@ public class ArtifactResolution extends AbstractSAML2ProfileHandler {
 
     /** {@inheritDoc} */
     public String getProfileId() {
-        return "urn:mace:shibboleth:2.0:idp:profiles:saml2:request:artifact";
+        return ArtifactResolutionConfiguration.PROFILE_ID;
     }
 
     /** {@inheritDoc} */
@@ -125,11 +124,9 @@ public class ArtifactResolution extends AbstractSAML2ProfileHandler {
                 requestContext.setFailureStatus(buildStatus(StatusCode.SUCCESS_URI, StatusCode.REQUEST_DENIED_URI,
                         "Artifact requester mismatch."));
             }
-            artifactMap.remove(requestContext.getArtifact());
-            SAMLObject referencedMessage = artifactEntry.getSamlMessage();
-            requestContext.setReferencedMessage(referencedMessage);
 
             // create the SAML response
+            requestContext.setReferencedMessage(artifactEntry.getSamlMessage());
             samlResponse = buildArtifactResponse(requestContext);
         } catch (ProfileException e) {
             samlResponse = buildArtifactErrorResponse(requestContext);
@@ -156,16 +153,15 @@ public class ArtifactResolution extends AbstractSAML2ProfileHandler {
     protected ArtifactResolutionRequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
             throws ProfileException {
         log.debug("Decoding message with decoder binding {}", getInboundBinding());
-        
-        MetadataProvider metadataProvider = getMetadataProvider();
 
         ArtifactResolutionRequestContext requestContext = new ArtifactResolutionRequestContext();
+
+        MetadataProvider metadataProvider = getMetadataProvider();
         requestContext.setMetadataProvider(metadataProvider);
-        requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
 
-        requestContext.setCommunicationProfileId(ArtifactResolutionConfiguration.PROFILE_ID);
         requestContext.setInboundMessageTransport(inTransport);
         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
+        requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
 
         requestContext.setOutboundMessageTransport(outTransport);
@@ -187,58 +183,61 @@ public class ArtifactResolution extends AbstractSAML2ProfileHandler {
                     "Message did not meet security requirements"));
             throw new ProfileException("Message did not meet security requirements", e);
         } finally {
-            // Set as much information as can be retrieved from the decoded message
-            requestContext.setArtifact(requestContext.getInboundSAMLMessage().getArtifact().getArtifact());
-
-            String relyingPartyId = requestContext.getInboundMessageIssuer();
-            RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
-            if (rpConfig == null) {
-                log.error("Unable to retrieve relying party configuration data for entity with ID {}", relyingPartyId);
-                throw new ProfileException("Unable to retrieve relying party configuration data for entity with ID "
-                        + relyingPartyId);
-            }
-            requestContext.setRelyingPartyConfiguration(rpConfig);
-
-            ArtifactResolutionConfiguration profileConfig = (ArtifactResolutionConfiguration) rpConfig
-                    .getProfileConfiguration(ArtifactResolutionConfiguration.PROFILE_ID);
-            if (profileConfig != null) {
-                requestContext.setProfileConfiguration(profileConfig);
-                if (profileConfig.getSigningCredential() != null) {
-                    requestContext.setOutboundSAMLMessageSigningCredential(profileConfig.getSigningCredential());
-                } else if (rpConfig.getDefaultSigningCredential() != null) {
-                    requestContext.setOutboundSAMLMessageSigningCredential(rpConfig.getDefaultSigningCredential());
-                }
-            }
+            populateRequestContext(requestContext);
+            populateSAMLMessageInformation(requestContext);
+            populateProfileInformation(requestContext);
+        }
+    }
 
-            requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
-
-            String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
-            requestContext.setLocalEntityId(assertingPartyId);
-            try {
-                EntityDescriptor localEntityDescriptor = metadataProvider.getEntityDescriptor(assertingPartyId);
-                if (localEntityDescriptor != null) {
-                    requestContext.setLocalEntityMetadata(localEntityDescriptor);
-                    requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
-                    requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
-                            .getAttributeAuthorityDescriptor(SAMLConstants.SAML20P_NS));
-                }
-            } catch (MetadataProviderException e) {
-                log.error("Unable to locate metadata for asserting party");
-                requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
-                        "Error locating asserting party metadata"));
-                throw new ProfileException("Error locating asserting party metadata");
-            }
+    /** {@inheritDoc} */
+    protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException {
+        super.populateRelyingPartyInformation(requestContext);
+
+        EntityDescriptor relyingPartyMetadata = requestContext.getPeerEntityMetadata();
+        if (relyingPartyMetadata != null) {
+            requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
+            requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML20P_NS));
+        }
+    }
+
+    /** {@inheritDoc} */
+    protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException {
+        super.populateAssertingPartyInformation(requestContext);
+
+        EntityDescriptor localEntityDescriptor = requestContext.getLocalEntityMetadata();
+        if (localEntityDescriptor != null) {
+            requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
+            requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
+                    .getAttributeAuthorityDescriptor(SAMLConstants.SAML20P_NS));
         }
     }
 
     /**
+     * Populates the request context with information from the inbound SAML message.
+     * 
+     * This method requires the the following request context properties to be populated: inbound saml message
+     * 
+     * This methods populates the following request context properties: subject name identifier
+     * 
+     * @param requestContext current request context
+     * 
+     * @throws ProfileException thrown if the inbound SAML message or subject identifier is null
+     */
+    protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
+        ArtifactResolve samlMessage = (ArtifactResolve) requestContext.getInboundSAMLMessage();
+        ((ArtifactResolutionRequestContext) requestContext).setArtifact(samlMessage.getArtifact().getArtifact());
+    }
+
+    /**
      * Selects the appropriate endpoint for the relying party and stores it in the request context.
      * 
      * @param requestContext current request context
      * 
      * @return Endpoint selected from the information provided in the request context
      */
-    protected Endpoint selectEndpoint(ArtifactResolutionRequestContext requestContext) {
+    protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) {
         Endpoint endpoint;
 
         if (getInboundBinding().equals(SAMLConstants.SAML2_SOAP11_BINDING_URI)) {
@@ -322,20 +321,12 @@ public class ArtifactResolution extends AbstractSAML2ProfileHandler {
             this.artifact = saml2Artifact;
         }
 
-        /**
-         * Gets the SAML message referenced by the artifact.
-         * 
-         * @return SAML message referenced by the artifact
-         */
+        /** {@inheritDoc} */
         public SAMLObject getReferencedMessage() {
             return referencedMessage;
         }
 
-        /**
-         * Sets the SAML message referenced by the artifact.
-         * 
-         * @param message SAML message referenced by the artifact
-         */
+        /** {@inheritDoc} */
         public void setReferencedMessage(SAMLObject message) {
             referencedMessage = message;
         }