Integrating enterprise search systems with custom access control application programming interfaces

• US 8,341,651 B2
• Filed: 01/10/2007
• Issued: 12/25/2012
• Est. Priority Date: 01/10/2007
• Status: Active Grant

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Kapadia, Arshish Cyrus, Burke, Jonah Sarbin
• Primary Examiner(s): Ho, Andy
• Assistant Examiner(s): DAO, TUAN C.
• Application Number:
  US11/651,657
• Publication Number:
  US 20080168037A1
• Time in Patent Office: 2,176 Days
• Field of Search: None
• US Class Current: 719/328
• CPC Class Codes: G06F 21/6236 between heterogeneous systems
• CPC Class Codes: G06F 9/4486 Formation of subprogram jump address

Abstract

Methods and computer-readable media are provided herein for integrating enterprise search systems with proprietary back-end content store access control APIs. A declarative metadata model is utilized to create and store data defining a custom API exposed by a back-end content store for retrieving access rights for documents stored therein. A normalized API for obtaining access rights for a document is also exposed. When a call is made to the normalized API, the stored data is utilized to transform the call to the normalized API into a call to the custom API.

Claims

1. A computer-implemented method for integrating enterprise search with a custom document access control application programming interface (API), the computer-implemented method comprising performing computer-implemented operations for:

storing declaratively defined metadata comprising an XML formatted file defining a custom API for obtaining one or more access rights for a document, wherein the declaratively defined metadata comprises data identifying one or more parameters of a method exposed by the custom API for obtaining access rights for a specified document and data indicating whether each of the parameters is an input parameter or an output parameter;

exposing a normalized API for obtaining access rights for a document;

receiving a call to a method exposed by the normalized API requesting access rights for the specified document, wherein the method exposed by the normalized API receives a parameter identifying a current user initiating a document request;

in response to receiving the call to the method exposed by the normalized API, using the declaratively defined metadata to transform the call to the method exposed by the normalized API into a call to the method exposed by the custom API for obtaining the access rights for the specified document;

receiving the access rights in response to the call to the method exposed by the custom API; and

returning the requested access rights in response to the call to the method exposed by the normalized API.

2. The method of claim 1, wherein the declaratively defined metadata further comprises default values for the parameters.

3. The method of claim 2, wherein the declaratively defined metadata further comprises data identifying one of the parameters as corresponding to an identifier for a document for which access rights are requested, and wherein the method exposed by the normalized API receives a parameter identifying the document for which access rights are requested.

4. The method of claim 3, wherein using the declaratively defined metadata to transform the call to the method exposed by the normalized API into a call to the method exposed by the custom API for the requested access rights for the specified document comprises:

instantiating the call to the method exposed by the custom API using the default values for the parameters;

substituting the parameter identifying the document for which access rights are requested received with the call to the normalized API for the default value of the parameter corresponding to an identifier for a document for which access rights are requested; and

executing the call to the method exposed by the custom API.

5. The method of claim 4, wherein the declaratively defined metadata further comprises data identifying one of the parameters as corresponding to a system supplied value.

6. The method of claim 5, wherein transforming the call to the method exposed by the normalized API into a call to the method exposed by the custom API for the access rights for the specified document further comprises:

substituting the parameter identifying the current user for the default value of the parameter corresponding to a system supplied value.

7. The method of claim 2, wherein the call to the method exposed by the normalized API is generated by a search crawler program.

8. The method of claim 2, wherein the call to the method exposed by the normalized API is generated by a search query processor.

9. A computer-readable medium that is not a signal having computer-executable instructions stored thereon which, when executed by a computer, cause the computer to:

expose a normalized application programming interface (API) for obtaining one or more access rights for a document;

receive a call to a method exposed by the normalized API for retrieving access rights for a document, the call including a document identifier for a document and a user identifier identifying a current user initiating a document request;

construct a call to a method exposed by a custom API for obtaining access rights for a document in response to the call to the method exposed by the normalized API, the call constructed using stored declaratively defined metadata comprising an XML formatted file that defines one or more default parameters of the method exposed by the custom API, the document identifier, and the user identifier, wherein the declaratively defined metadata further comprises data identifying one of the parameters as corresponding to the document identifier and one of the parameters as corresponding to the user identifier;

execute the call to the method exposed by the custom API;

receive the access rights for the document in response to the call to the method exposed by the custom API; and

to

return the access rights for the document in response to the call to the method exposed by the normalized API.

10. The computer-readable medium of claim 9, wherein the method exposed by the normalized API comprises a method for retrieving access rights for a plurality of documents, wherein the method exposed by the custom API comprises a method for retrieving access rights for a single document, and wherein the computer-readable medium has further computer-executable instructions stored thereon for constructing a separate call to the method exposed by the custom API for each of the plurality of documents identified in a call to the method exposed by the normalized API.

11. The computer-readable medium of claim 9, wherein the call to the method exposed by the normalized API is received from a search crawler program.

12. The computer-readable medium of claim 9, wherein the call to the method exposed by the normalized API is received from a search query processor.

13. A computer-implemented method for integrating enterprise search with a custom document access control application programming interface (API), the computer-implemented method comprising performing computer-implemented operations for:

storing declaratively defined metadata comprising an XML formatted file that defines one or more methods exposed by a custom document access control API, the declaratively defined data comprising default values for one or more parameters used by the methods, data identifying the parameters that correspond to a document identifier, and data identifying the parameters that correspond to a user identifier;

exposing a normalized API for obtaining one or more access rights for a document, the access rights being stored in a back-end computing system and accessed using one of the methods exposed by the custom document access control API;

receiving a call to a method exposed by the normalized API, the call including a document identifier corresponding to a document for which access rights should be obtained and a user identifier for a current user initiating a document request;

in response to the call to the method exposed by the normalized API, using the declaratively defined metadata to translate the call to the method exposed by the normalized API into a call to a method exposed by the custom document access control API using the default values, the document identifier, and the user identifier;

in response to the call to the method exposed by the custom document access control API, receiving one or more access rights for the document; and

returning the access rights for the document in response to the call to the method exposed by the normalized API.

14. The method of claim 13, wherein the call to the method exposed by the normalized API is generated by a search crawler program.

15. The method of claim 14, wherein the method exposed by the normalized API is operative to retrieve the access rights for one or more users to a single document.

16. The method of claim 13, wherein the call to the method exposed by the normalized API is generated by a search query processor.

17. The method of claim 15, wherein the method exposed by the normalized API is operative to retrieve the access rights to one or more documents for a current user of the search query processor.