inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-14 17:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged API-STRIKES-BACK (5.2.0) to HEAD (5.2)

Browse Source 
125666 jkaabimofrad: RA-933: Fixed API tests failures by refactoring the noAuth functionality.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127560 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Jamal Kaabi-Mofrad
2016-06-02 21:37:21 +00:00
parent 058d52387f
commit f31d286c8c
3 changed files with 258 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

494
source/java/org/alfresco/rest/api/PublicApiDeclarativeRegistry.java
View File

@@ -26,12 +26,14 @@ import java.util.Map;
import java.util.ResourceBundle; import java.util.ResourceBundle;
import java.util.Set; import java.util.Set;
import org.alfresco.rest.api.authentications.AuthenticationTicketsEntityResource;
import org.alfresco.rest.framework.Api; import org.alfresco.rest.framework.Api;
import org.alfresco.rest.framework.core.ResourceLocator; import org.alfresco.rest.framework.core.ResourceLocator;
import org.alfresco.rest.framework.core.ResourceWithMetadata; import org.alfresco.rest.framework.core.ResourceWithMetadata;
import org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction; import org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction;
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction; import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceBinaryAction; import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceBinaryAction;
import org.alfresco.rest.framework.resource.actions.interfaces.ResourceAction;
import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.StringUtils;
import org.springframework.extensions.webscripts.ArgumentTypeDescription; import org.springframework.extensions.webscripts.ArgumentTypeDescription;
import org.springframework.extensions.webscripts.Container; import org.springframework.extensions.webscripts.Container;
@@ -93,13 +95,12 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
*/ */
public Match findWebScript(String method, String uri) public Match findWebScript(String method, String uri)
{ {
Match match = null; Match match;
HttpMethod httpMethod = HttpMethod.valueOf(method); HttpMethod httpMethod = HttpMethod.valueOf(method);
boolean isPost = httpMethod.equals(HttpMethod.POST); if (HttpMethod.GET.equals(httpMethod))
if (httpMethod.equals(HttpMethod.GET) || isPost)
{ {
if (!isPost && uri.equals(PublicApiTenantWebScriptServletRequest.NETWORKS_PATH)) if (uri.equals(PublicApiTenantWebScriptServletRequest.NETWORKS_PATH))
{ {
Map<String, String> templateVars = new HashMap<>(); Map<String, String> templateVars = new HashMap<>();
templateVars.put("apiScope", "public"); templateVars.put("apiScope", "public");
@@ -107,7 +108,7 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
templateVars.put("apiName", "networks"); templateVars.put("apiName", "networks");
match = new Match("", templateVars, "", getNetworksWebScript); match = new Match("", templateVars, "", getNetworksWebScript);
} }
else if (!isPost && uri.equals(PublicApiTenantWebScriptServletRequest.NETWORK_PATH)) else if (uri.equals(PublicApiTenantWebScriptServletRequest.NETWORK_PATH))
{ {
Map<String, String> templateVars = new HashMap<>(); Map<String, String> templateVars = new HashMap<>();
templateVars.put("apiScope", "public"); templateVars.put("apiScope", "public");
@@ -118,22 +119,17 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
else else
{ {
match = super.findWebScript(method, uri); match = super.findWebScript(method, uri);
if (match == null)
Map<String, String> templateVars = match.getTemplateVars();
if (templateVars.get("apiName") != null)
{ {
// NOTE: noAuth currently only exposed for GET return null;
Api api = determineApi(templateVars); }
Map<String, String> templateVars = match.getTemplateVars();
// TODO can we avoid locating resource more than once (or at least provide a common code to determine the GET resourceAction) ? ResourceWithMetadata rwm = getResourceWithMetadataOrNull(templateVars, httpMethod);
ResourceWithMetadata rwm = locator.locateResource(api, templateVars, HttpMethod.valueOf(method)); if (rwm != null)
{
Class resAction = null; Class<? extends ResourceAction> resAction = null;
String entityId = templateVars.get(ResourceLocator.ENTITY_ID); String entityId = templateVars.get(ResourceLocator.ENTITY_ID);
String relationshipId = templateVars.get(ResourceLocator.RELATIONSHIP_ID);
switch (rwm.getMetaData().getType()) switch (rwm.getMetaData().getType())
{ {
case ENTITY: case ENTITY:
@@ -150,10 +146,6 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
{ {
resAction = EntityResourceAction.Read.class; resAction = EntityResourceAction.Read.class;
} }
else if (EntityResourceAction.Create.class.isAssignableFrom(rwm.getResource().getClass()))
{
resAction = EntityResourceAction.Create.class;
}
} }
break; break;
case PROPERTY: case PROPERTY:
@@ -169,232 +161,37 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
} }
} }
break; break;
case RELATIONSHIP:
if (StringUtils.isNotBlank(relationshipId))
{
if (RelationshipResourceAction.ReadById.class.isAssignableFrom(rwm.getResource().getClass()))
{
resAction = RelationshipResourceAction.ReadById.class;
}
}
else
{
if (RelationshipResourceAction.Read.class.isAssignableFrom(rwm.getResource().getClass()))
{
resAction = RelationshipResourceAction.Read.class;
}
}
break;
default: default:
break; break;
} }
final boolean noAuth = (resAction != null && rwm.getMetaData().isNoAuth(resAction)); final boolean noAuth = (resAction != null && rwm.getMetaData().isNoAuth(resAction));
if (noAuth) if (noAuth)
{ {
final WebScript webScript = match.getWebScript();
// TODO is there a better way (to dynamically override "requiredAuthentication") or handle noAuth check earlier ?
WebScript noAuthWebScriptWrapper = new WebScript()
{
@Override
public void init(Container container, Description description)
{
webScript.init(container, description);
}
@Override
public Description getDescription()
{
final Description d = webScript.getDescription();
return new Description()
{
@Override
public String getStorePath()
{
return d.getStorePath();
}
@Override
public String getScriptPath()
{
return d.getScriptPath();
}
@Override
public Path getPackage()
{
return d.getPackage();
}
@Override
public String getDescPath()
{
return d.getDescPath();
}
@Override
public InputStream getDescDocument() throws IOException
{
return d.getDescDocument();
}
@Override
public String getKind()
{
return d.getKind();
}
@Override
public Set<String> getFamilys()
{
return d.getFamilys();
}
@Override
public RequiredAuthentication getRequiredAuthentication()
{
return RequiredAuthentication.none;
}
@Override
public String getRunAs()
{
return d.getRunAs();
}
@Override
public RequiredTransaction getRequiredTransaction()
{
return d.getRequiredTransaction();
}
@Override
public RequiredTransactionParameters getRequiredTransactionParameters()
{
return d.getRequiredTransactionParameters();
}
@Override
public RequiredCache getRequiredCache()
{
return d.getRequiredCache();
}
@Override
public String getMethod()
{
return d.getMethod();
}
@Override
public String[] getURIs()
{
return d.getURIs();
}
@Override
public FormatStyle getFormatStyle()
{
return d.getFormatStyle();
}
@Override
public String getDefaultFormat()
{
return d.getDefaultFormat();
}
@Override
public NegotiatedFormat[] getNegotiatedFormats()
{
return d.getNegotiatedFormats();
}
@Override
public Map<String, Serializable> getExtensions()
{
return d.getExtensions();
}
@Override
public Lifecycle getLifecycle()
{
return d.getLifecycle();
}
@Override
public boolean getMultipartProcessing()
{
return d.getMultipartProcessing();
}
@Override
public void setMultipartProcessing(boolean b)
{
d.setMultipartProcessing(b);
}
@Override
public ArgumentTypeDescription[] getArguments()
{
return d.getArguments();
}
@Override
public TypeDescription[] getRequestTypes()
{
return d.getRequestTypes();
}
@Override
public TypeDescription[] getResponseTypes()
{
return d.getResponseTypes();
}
@Override
public String getId()
{
return d.getId();
}
@Override
public String getShortName()
{
return d.getShortName();
}
@Override
public String getDescription()
{
return d.getDescription();
}
};
}
@Override
public ResourceBundle getResources()
{
return webScript.getResources();
}
@Override
public void execute(WebScriptRequest webScriptRequest, WebScriptResponse webScriptResponse) throws IOException
{
webScript.execute(webScriptRequest, webScriptResponse);
}
@Override
public void setURLModelFactory(URLModelFactory urlModelFactory)
{
webScript.setURLModelFactory(urlModelFactory);
}
};
// override match with noAuth // override match with noAuth
match = new Match(match.getTemplate(), match.getTemplateVars(), match.getPath(), noAuthWebScriptWrapper); match = overrideMatch(match);
}
}
}
}
else if (HttpMethod.POST.equals(httpMethod))
{
match = super.findWebScript(method, uri);
if (match != null && uri.endsWith(AuthenticationTicketsEntityResource.COLLECTION_RESOURCE_NAME))
{
ResourceWithMetadata rwm = getResourceWithMetadataOrNull(match.getTemplateVars(), httpMethod);
if (rwm != null && AuthenticationTicketsEntityResource.class.equals(rwm.getResource().getClass()))
{
Class<? extends ResourceAction> resAction = null;
if (EntityResourceAction.Create.class.isAssignableFrom(rwm.getResource().getClass()))
{
resAction = EntityResourceAction.Create.class;
}
final boolean noAuth = (resAction != null && rwm.getMetaData().isNoAuth(resAction));
if (noAuth)
{
// override match with noAuth
match = overrideMatch(match);
} }
} }
} }
@@ -407,6 +204,223 @@ public class PublicApiDeclarativeRegistry extends DeclarativeRegistry
return match; return match;
} }
private ResourceWithMetadata getResourceWithMetadataOrNull(Map<String, String> templateVars, HttpMethod method)
{
if (templateVars.get("apiName") != null)
{
// NOTE: noAuth currently only exposed for GET or Create Ticket (login)
Api api = determineApi(templateVars);
// TODO can we avoid locating resource more than once (or at least provide a common code to determine the GET resourceAction) ?
return locator.locateResource(api, templateVars, method);
}
return null;
}
private Match overrideMatch(final Match match)
{
// TODO is there a better way (to dynamically override "requiredAuthentication") or handle noAuth check earlier ?
WebScript noAuthWebScriptWrapper = new WebScript()
{
@Override
public void init(Container container, Description description)
{
match.getWebScript().init(container, description);
}
@Override
public Description getDescription()
{
final Description d = match.getWebScript().getDescription();
return new Description()
{
@Override
public String getStorePath()
{
return d.getStorePath();
}
@Override
public String getScriptPath()
{
return d.getScriptPath();
}
@Override
public Path getPackage()
{
return d.getPackage();
}
@Override
public String getDescPath()
{
return d.getDescPath();
}
@Override
public InputStream getDescDocument() throws IOException
{
return d.getDescDocument();
}
@Override
public String getKind()
{
return d.getKind();
}
@Override
public Set<String> getFamilys()
{
return d.getFamilys();
}
@Override
public RequiredAuthentication getRequiredAuthentication()
{
return RequiredAuthentication.none;
}
@Override
public String getRunAs()
{
return d.getRunAs();
}
@Override
public RequiredTransaction getRequiredTransaction()
{
return d.getRequiredTransaction();
}
@Override
public RequiredTransactionParameters getRequiredTransactionParameters()
{
return d.getRequiredTransactionParameters();
}
@Override
public RequiredCache getRequiredCache()
{
return d.getRequiredCache();
}
@Override
public String getMethod()
{
return d.getMethod();
}
@Override
public String[] getURIs()
{
return d.getURIs();
}
@Override
public FormatStyle getFormatStyle()
{
return d.getFormatStyle();
}
@Override
public String getDefaultFormat()
{
return d.getDefaultFormat();
}
@Override
public NegotiatedFormat[] getNegotiatedFormats()
{
return d.getNegotiatedFormats();
}
@Override
public Map<String, Serializable> getExtensions()
{
return d.getExtensions();
}
@Override
public Lifecycle getLifecycle()
{
return d.getLifecycle();
}
@Override
public boolean getMultipartProcessing()
{
return d.getMultipartProcessing();
}
@Override
public void setMultipartProcessing(boolean b)
{
d.setMultipartProcessing(b);
}
@Override
public ArgumentTypeDescription[] getArguments()
{
return d.getArguments();
}
@Override
public TypeDescription[] getRequestTypes()
{
return d.getRequestTypes();
}
@Override
public TypeDescription[] getResponseTypes()
{
return d.getResponseTypes();
}
@Override
public String getId()
{
return d.getId();
}
@Override
public String getShortName()
{
return d.getShortName();
}
@Override
public String getDescription()
{
return d.getDescription();
}
};
}
@Override
public ResourceBundle getResources()
{
return match.getWebScript().getResources();
}
@Override
public void execute(WebScriptRequest webScriptRequest, WebScriptResponse webScriptResponse) throws IOException
{
match.getWebScript().execute(webScriptRequest, webScriptResponse);
}
@Override
public void setURLModelFactory(URLModelFactory urlModelFactory)
{
match.getWebScript().setURLModelFactory(urlModelFactory);
}
};
// override match with noAuth
return new Match(match.getTemplate(), match.getTemplateVars(), match.getPath(), noAuthWebScriptWrapper);
}
// note: same as ApiWebscript (apiName must not be null) // note: same as ApiWebscript (apiName must not be null)
private Api determineApi(Map<String, String> templateVars) private Api determineApi(Map<String, String> templateVars)
{ {

3
source/java/org/alfresco/rest/api/authentications/AuthenticationTicketsEntityResource.java
View File

@@ -43,6 +43,9 @@ public class AuthenticationTicketsEntityResource implements EntityResourceAction
EntityResourceAction.DeleteWithResponse, EntityResourceAction.DeleteWithResponse,
InitializingBean InitializingBean
{ {
// tickets => @EntityResource(name = "tickets" ...
public static final String COLLECTION_RESOURCE_NAME = "tickets";
private Authentications authentications; private Authentications authentications;
public void setAuthentications(Authentications authentications) public void setAuthentications(Authentications authentications)

2
source/java/org/alfresco/rest/framework/core/ResourceInspector.java
View File

@@ -302,7 +302,7 @@ public class ResourceInspector
{ {
if (! (httpMethod.equals(HttpMethod.GET) || httpMethod.equals(HttpMethod.POST))) if (! (httpMethod.equals(HttpMethod.GET) || httpMethod.equals(HttpMethod.POST)))
{ {
throw new IllegalArgumentException("@WebApiNoAuth should only be on GET methods: "+operation.getTitle()); throw new IllegalArgumentException("@WebApiNoAuth should only be on GET methods: "+operation.getTitle()+" Or POST method for creating a ticket.");
} }
helper.whenOperationNoAuth(resourceInterfaceWithOneMethod, aMethod); helper.whenOperationNoAuth(resourceInterfaceWithOneMethod, aMethod);
} }