Examples of org.apache.wink.common.model.opensearch.OpenSearchDescription

Package org.apache.wink.common.model.opensearch

Examples of org.apache.wink.common.model.opensearch.OpenSearchDescription

org.apache.wink.common.model.opensearch.OpenSearchDescription
m/-/spec/opensearch/1.1/">  </OpenSearchDescription> o The "ShortName" element Contains a brief human-readable title that identifies this search engine. Parent: OpenSearchDescription Restrictions: The value must contain 16 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element must appear exactly once. Example: <ShortName>Web Search</ShortName> o The "Description" element Contains a human-readable text description of the search engine. Parent: OpenSearchDescription Restrictions: The value must contain 1024 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element must appear exactly once. Example: <Description>Use Example.com to search the Web.</Description> o The "Url" element Describes an interface by which a search client can make search requests of the search engine. OpenSearch provides support for both index-based and page-based search engines. By default, both the first search result and the first page of search results are numbered "1". Search engines can use the "indexOffset" and "pageOffset" attributes to inform search clients of different starting values. Parent: OpenSearchDescription Attributes: template - Contains the search URL template to be processed according to the OpenSearch URL template syntax. Requirements: This attribute is required. type - Contains the MIME type of the search result format. Restrictions: The value must be a valid MIME type. Requirements: This attribute is required. indexOffset - Contains the index number of the first search result. Restrictions: The value must be an integer. Default: "1" Requirements: This attribute is optional. pageOffset - Contains the page number of the first set of search results. Restrictions: The value must be an integer. Default: "1". Requirements: This attribute is optional. Requirements: This element must appear one or more times. Example of a Url element describing the interface used to retrieve search results over RSS: <Url type="application/rss+xml" template="http://example.com/?q={searchTerms}&pw={startPage?}" /> Example of a Url element describing the interface used to retrieve 0-based search results over XHTML: <Url type="application/xhtml+xml" indexOffset="0" template="http://example.com/search?q={searchTerms}&start={startIndex?}" /> o The "Contact" element Contains an email address at which the maintainer of the description document can be reached. Parent: OpenSearchDescription Restrictions: The value must conform to the requirements of Section 3.4.1 "Addr-spec specification" in RFC 2822. Requirements: This element may appear zero or one time. Example: <Contact>admin@example.com</Contact> o The "Tags" element Contains a set of words that are used as keywords to identify and categorize this search content. Tags must be a single word and are delimited by the space character (' '). Parent: OpenSearchDescription Restrictions: The value must contain 256 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element may appear zero or one time. Example: <Tags>example web</Tags> o The "LongName" element Contains an extended human-readable title that identifies this search engine. Search clients should use the value of the ShortName element if this element is not available. Parent: OpenSearchDescription Restrictions: The value must contain 48 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element may appear zero or one time. Example: <LongName>Example.com Web Search</LongName> o The "Image" element Contains a URL that identifies the location of an image that can be used in association with this search content. Image sizes are offered as a hint to the search client. The search client will chose the most appropriate image for the available space and should give preference to those listed first in the OpenSearch description document. Square aspect ratios are recommended. When possible, search engines should offer a 16x16 image of type "image/x-icon" or "image/vnd.microsoft.icon" (the Microsoft ICON format) and a 64x64 image of type "image/jpeg" or "image/png". Parent: OpenSearchDescription Attributes: height - Contains the height, in pixels, of this image. Restrictions: The value must be a non-negative integer. Requirements: This attribute is optional. width - Contains the width, in pixels, of this image. Restrictions: The value must be a non-negative integer. Requirements: This attribute is optional. type - Contains the the MIME type of this image. Restrictions: The value must be a valid MIME type. Requirements: This attribute is optional. Restrictions: The value must be a URI. Requirements: This element may appear zero, one, or more times. Example: <Image height="16" width="16" type="image/x-icon">http://example.com/favicon.ico</Image> <Image height="64" width="64" type="image/png">http://example.com/websearch.png</Image> o The "Query" element Defines a search query that can be performed by search clients. Please see the OpenSearch Query element specification for more information. OpenSearch description documents should include at least one Query element of role="example" that is expected to return search results. Search clients may use this example query to validate that the search engine is working properly. Parent: OpenSearchDescription Requirements: This element may appear zero or more times. Example: <Query role="example" searchTerms="cat" /> o The "Developer" element Contains the human-readable name or identifier of the creator or maintainer of the description document. The developer is the person or entity that created the description document, and may or may not be the owner, author, or copyright holder of the source of the content itself. Parent: OpenSearchDescription Restrictions: The value must contain 64 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element may appear zero or one time. Example: <Developer>Example.com Development Team</Developer> o The "Attribution" element Contains a list of all sources or entities that should be credited for the content contained in the search feed. Parent: OpenSearchDescription Restrictions: The value must contain 256 or fewer characters of plain text. The value must not contain HTML or other markup. Requirements: This element may appear zero or one time. Example: <Attribution>Search data copyright Example.com, Inc.</Attribution> o The "SyndicationRight" element Contains a value that indicates the degree to which the search results provided by this search engine can be queried, displayed, and redistributed. Parent: OpenSearchDescription Values: The value must be one of the following strings (case insensitive): "open" - The search client may request search results. The search client may display the search results to end users. The search client may send the search results to other search clients. "limited" - The search client may request search results. The search client may display the search results to end users. The search client may not send the search results to other search clients. "private" - The search client may request search results. The search client may not display the search results to end users. The search client may not send the search results to other search clients. "closed" - The search client may not request search results. Default: "open" Requirements: This element may appear zero or one time. Example: <SyndicationRight>open</SyndicationRight> o The "AdultContent" element Contains a boolean value that should be set to true if the search results may contain material intended only for adults. As there are no universally applicable guidelines as to what constitutes "adult" content, the search engine should make a good faith effort to indicate when there is a possibility that search results may contain material inappropriate for all audiences. Parent: OpenSearchDescription Values: The values "false", "FALSE", "0", "no", and "NO" will be considered boolean FALSE; all other strings will be considered boolean TRUE. Default: "false" Requirements: This element may appear zero or one time. Example: <AdultContent>false</AdultContent> o The "Language" element Contains a string that indicates that the search engine supports search results in the specified language. An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages. Parent: OpenSearchDescription Restrictions: The value must conform to the XML 1.0 Language Identification, as specified by RFC 3066. In addition, the value of "*" will signify that the search engine does not restrict search results to any particular language. Default: "*". Requirements: This element may appear zero, one, or more times. Example: <Language>en-us</Language> <Language>*</Language> o The "InputEncoding" element Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request. Parent: OpenSearchDescription Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments. Default: "UTF-8". Requirements: This element may appear zero, one, or more times. Example: <InputEncoding>UTF-8</InputEncoding> o The "OutputEncoding" element Contains a string that indicates that the search engine supports search responses encoded with the specified character encoding. An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response. Parent: OpenSearchDescription Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments. Default: "UTF-8". Requirements: This element may appear zero, one, or more times. Example: <OutputEncoding>UTF-8</OutputEncoding>

     */
    @GET
    @Produces(MediaTypeUtils.OPENSEARCH)
    public OpenSearchDescription getOpenSearch(@Context UriInfo info) {
        String baseUri = info.getAbsolutePath().toString();
        OpenSearchDescription openSearchDescription = new OpenSearchDescription();
        openSearchDescription.setShortName("HP Defect Manager search engine");
        openSearchDescription.setDescription("You can search defects in HP Defect Manager");
        openSearchDescription.setLongName("HP Defect Manager search engine");
        openSearchDescription.setContact("john.smith@example.com");
        openSearchDescription.setDeveloper("John Smith");
        openSearchDescription.addLanguage("en-US");
        openSearchDescription.setTags("defect bug");
        openSearchDescription.addInputEncoding("UTF-8");
        openSearchDescription.addOutputEncoding("UTF-8");


        // set OpenSearch URL parameters
        OpenSearchParameter severityParameter =
            new OpenSearchParameter(SEVERIIY, URN_SEVERIIY, false);
        OpenSearchParameter ftsParameter =
            new OpenSearchParameter(FTS, OpenSearchParameter.OpenSearchParams.searchTerms
                .toString(), false);
        OpenSearchParameter assignedToParameter =
            new OpenSearchParameter(ASSIGNED_TO, URN_ASSIGNED_TO, false);


        // create Search URL & populate search parameters for browsers
        OpenSearchUrl openSearchUrlForBrowsers = new OpenSearchUrl();
        openSearchUrlForBrowsers.addOpenSearchParameter(ftsParameter);
        openSearchUrlForBrowsers.setType(MediaType.TEXT_HTML);


        // create Search URL & populate search parameters
        OpenSearchUrl openSearchUrl = new OpenSearchUrl();
        openSearchUrl.addOpenSearchParameter(severityParameter);
        openSearchUrl.addOpenSearchParameter(ftsParameter);
        openSearchUrl.addOpenSearchParameter(assignedToParameter);
        openSearchUrl.setType(MediaType.TEXT_HTML);


        // create open search base uri
        StringBuilder openSearchUrlBuilder = new StringBuilder(baseUri);


        openSearchUrl.setBaseUri(openSearchUrlBuilder.toString());
        openSearchUrlForBrowsers.setBaseUri(openSearchUrlBuilder.toString());


        // add URLs to OpenSearch
        openSearchDescription.addUrl(openSearchUrlForBrowsers);
        openSearchDescription.addUrl(openSearchUrl);


        // add OpenSearch Query element
        OpenSearchQuery openSearchQuery = new OpenSearchQuery();
        openSearchQuery.setRole(OpenSearchQuery.QueryRole.example.toString());
        openSearchQuery.setSearchTerms("Search Terms");
        openSearchDescription.addQuery(openSearchQuery);


        // add OpenSearch Images
        OpenSearchImage openSearchImage;
        openSearchImage =
            OpenSearchUtils.createOpenSearchImage(MediaTypeUtils.IMAGE_JPEG, openSearchUrlBuilder
                .toString() + "splash.jpg");
        openSearchDescription.addNewImage(openSearchImage);


        return openSearchDescription;
    }

View Full Code Here

     */
    @GET
    @Produces(MediaTypeUtils.OPENSEARCH)
    public OpenSearchDescription getOpenSearch(@Context UriInfo info) {
        String baseUri = info.getAbsolutePath().toString();
        OpenSearchDescription openSearchDescription = new OpenSearchDescription();
        openSearchDescription.setShortName("HP Defect Manager search engine");
        openSearchDescription.setDescription("You can search defects in HP Defect Manager");
        openSearchDescription.setLongName("HP Defect Manager search engine");
        openSearchDescription.setContact("john.smith@example.com");
        openSearchDescription.setDeveloper("John Smith");
        openSearchDescription.addLanguage("en-US");
        openSearchDescription.setTags("defect bug");
        openSearchDescription.addInputEncoding("UTF-8");
        openSearchDescription.addOutputEncoding("UTF-8");


        // set OpenSearch URL parameters
        OpenSearchParameter severityParameter =
            new OpenSearchParameter(SEVERIIY, URN_SEVERIIY, false);
        OpenSearchParameter ftsParameter =
            new OpenSearchParameter(FTS, OpenSearchParameter.OpenSearchParams.searchTerms
                .toString(), false);
        OpenSearchParameter assignedToParameter =
            new OpenSearchParameter(ASSIGNED_TO, URN_ASSIGNED_TO, false);


        // create Search URL & populate search parameters for browsers
        OpenSearchUrl openSearchUrlForBrowsers = new OpenSearchUrl();
        openSearchUrlForBrowsers.addOpenSearchParameter(ftsParameter);
        openSearchUrlForBrowsers.setType(MediaType.TEXT_HTML);


        // create Search URL & populate search parameters
        OpenSearchUrl openSearchUrl = new OpenSearchUrl();
        openSearchUrl.addOpenSearchParameter(severityParameter);
        openSearchUrl.addOpenSearchParameter(ftsParameter);
        openSearchUrl.addOpenSearchParameter(assignedToParameter);
        openSearchUrl.setType(MediaType.TEXT_HTML);


        // create open search base uri
        StringBuilder openSearchUrlBuilder = new StringBuilder(baseUri);


        openSearchUrl.setBaseUri(openSearchUrlBuilder.toString());
        openSearchUrlForBrowsers.setBaseUri(openSearchUrlBuilder.toString());


        // add URLs to OpenSearch
        openSearchDescription.addUrl(openSearchUrlForBrowsers);
        openSearchDescription.addUrl(openSearchUrl);


        // add OpenSearch Query element
        OpenSearchQuery openSearchQuery = new OpenSearchQuery();
        openSearchQuery.setRole(OpenSearchQuery.QueryRole.example.toString());
        openSearchQuery.setSearchTerms("Search Terms");
        openSearchDescription.addQuery(openSearchQuery);


        // add OpenSearch Images
        OpenSearchImage openSearchImage;
        openSearchImage =
            OpenSearchUtils.createOpenSearchImage(MediaTypeUtils.IMAGE_JPEG, openSearchUrlBuilder
                .toString() + "splash.jpg");
        openSearchDescription.addNewImage(openSearchImage);


        return openSearchDescription;
    }

View Full Code Here

     */
    @GET
    @Produces(MediaTypeUtils.OPENSEARCH)
    public OpenSearchDescription getOpenSearch(@Context UriInfo info) {
        String baseUri = info.getAbsolutePath().toString();
        OpenSearchDescription openSearchDescription = new OpenSearchDescription();
        openSearchDescription.setShortName("HP Defect Manager search engine");
        openSearchDescription.setDescription("You can search defects in HP Defect Manager");
        openSearchDescription.setLongName("HP Defect Manager search engine");
        openSearchDescription.setContact("john.smith@example.com");
        openSearchDescription.setDeveloper("John Smith");
        openSearchDescription.addLanguage("en-US");
        openSearchDescription.setTags("defect bug");
        openSearchDescription.addInputEncoding("UTF-8");
        openSearchDescription.addOutputEncoding("UTF-8");


        // set OpenSearch URL parameters
        OpenSearchParameter severityParameter =
            new OpenSearchParameter(SEVERIIY, URN_SEVERIIY, false);
        OpenSearchParameter ftsParameter =
            new OpenSearchParameter(FTS, OpenSearchParameter.OpenSearchParams.searchTerms
                .toString(), false);
        OpenSearchParameter assignedToParameter =
            new OpenSearchParameter(ASSIGNED_TO, URN_ASSIGNED_TO, false);


        // create Search URL & populate search parameters for browsers
        OpenSearchUrl openSearchUrlForBrowsers = new OpenSearchUrl();
        openSearchUrlForBrowsers.addOpenSearchParameter(ftsParameter);
        openSearchUrlForBrowsers.setType(MediaType.TEXT_HTML);


        // create Search URL & populate search parameters
        OpenSearchUrl openSearchUrl = new OpenSearchUrl();
        openSearchUrl.addOpenSearchParameter(severityParameter);
        openSearchUrl.addOpenSearchParameter(ftsParameter);
        openSearchUrl.addOpenSearchParameter(assignedToParameter);
        openSearchUrl.setType(MediaType.TEXT_HTML);


        // create open search base uri
        StringBuilder openSearchUrlBuilder = new StringBuilder(baseUri);


        openSearchUrl.setBaseUri(openSearchUrlBuilder.toString());
        openSearchUrlForBrowsers.setBaseUri(openSearchUrlBuilder.toString());


        // add URLs to OpenSearch
        openSearchDescription.addUrl(openSearchUrlForBrowsers);
        openSearchDescription.addUrl(openSearchUrl);


        // add OpenSearch Query element
        OpenSearchQuery openSearchQuery = new OpenSearchQuery();
        openSearchQuery.setRole(OpenSearchQuery.QueryRole.example.toString());
        openSearchQuery.setSearchTerms("Search Terms");
        openSearchDescription.addQuery(openSearchQuery);


        // add OpenSearch Images
        OpenSearchImage openSearchImage;
        openSearchImage =
            OpenSearchUtils.createOpenSearchImage(MediaTypeUtils.IMAGE_JPEG, openSearchUrlBuilder
                .toString() + "splash.jpg");
        openSearchDescription.addNewImage(openSearchImage);


        return openSearchDescription;
    }

View Full Code Here

            + resultSerialization, diff.similar());


    }


    public void testOpenSearchDescriptor() {
        OpenSearchDescription openSearchDescriptor = buildOpenSearchDescriptor(BASE_URL);
        assertEquals("Expected and actual values of Short Name are not same",
                     SHORT_NAME,
                     openSearchDescriptor.getShortName());
        assertEquals("Expected and actual values of  Description are not same",
                     DESC,
                     openSearchDescriptor.getDescription());
        assertEquals("Expected and actual values of  Long Name are not same",
                     LONG_NAME,
                     openSearchDescriptor.getLongName());
        assertEquals("Expected and actual values of  Contact are not same",
                     CONTACT,
                     openSearchDescriptor.getContact());
        assertEquals("Incorrect Developer", DEVELOPER, openSearchDescriptor.getDeveloper());


        List<String> languageArray = openSearchDescriptor.getLanguage();
        Collections.sort(languageArray);
        int binarySearchResult = Collections.binarySearch(languageArray, LANG);
        if (binarySearchResult < 0) {
            assertFalse("Accept Language " + LANG
                + " does not exist in array of expected languages"
                + languageArray, true);
        }


        assertEquals("Expected and actual values of  Tags are not same", TAGS, openSearchDescriptor
            .getTags());


        List<String> inputEncodingArray = openSearchDescriptor.getInputEncoding();
        Collections.sort(inputEncodingArray);
        int inputEncodingArraySearchResult = Collections.binarySearch(inputEncodingArray, ENCODING);
        if (inputEncodingArraySearchResult < 0) {
            assertFalse("Input Encoding " + ENCODING
                + "  does not exist in array of input incoding values "
                + inputEncodingArray, true);
        }


        List<String> outputEncodingArray = openSearchDescriptor.getOutputEncoding();
        Collections.sort(outputEncodingArray);
        int outputEncodingArraySearchResult =
            Collections.binarySearch(outputEncodingArray, ENCODING);
        if (outputEncodingArraySearchResult < 0) {
            assertFalse("Output Encoding " + ENCODING
                + "  does not exist in array of output incoding values "
                + outputEncodingArray, true);
        }


        List<OpenSearchUrl> urlArray = openSearchDescriptor.getUrl();
        if (urlArray != null && urlArray.size() != 0) {
            for (OpenSearchUrl url : urlArray) {
                String openSearchUrlTemplate = url.getTemplate();
                if (!(openSearchUrlTemplate.equals(SEARCH_URL1) || openSearchUrlTemplate
                    .equals(SEARCH_URL2))) {
                    assertFalse("Expected and actual values of  Url are not same " + " expected:"
                        + SEARCH_URL1
                        + ""
                        + SEARCH_URL2
                        + " actual:"
                        + openSearchUrlTemplate, true);
                }
            }
        }


        List<OpenSearchQuery> queryArray = openSearchDescriptor.getQuery();
        if (urlArray == null || urlArray.size() == 0) {
            assertFalse("Open Search Query is not defined", true);
        } else {
            OpenSearchQuery openSearchQuery = queryArray.get(0);
            assertEquals("Expected and actual values of  Count are not same ",

View Full Code Here

                         openSearchQuery.getTotalResults().toString());
        }
    }


    private OpenSearchDescription buildOpenSearchDescriptor(String baseUri) {
        OpenSearchDescription openSearchDescriptor = new OpenSearchDescription();
        openSearchDescriptor.setShortName(SHORT_NAME);
        openSearchDescriptor.setDescription(DESC);
        openSearchDescriptor.setLongName(LONG_NAME);
        openSearchDescriptor.setContact(CONTACT);
        openSearchDescriptor.setDeveloper(DEVELOPER);
        openSearchDescriptor.addLanguage(LANG);
        openSearchDescriptor.setTags(TAGS);
        openSearchDescriptor.addInputEncoding(ENCODING);
        openSearchDescriptor.addOutputEncoding(ENCODING);


        // set OpenSearch URL parameters
        OpenSearchParameter severityParameter =
            new OpenSearchParameter(SEVERIIY, URN_SEVERIIY, false);
        OpenSearchParameter ftsParameter =
            new OpenSearchParameter(FTS, OpenSearchParameter.OpenSearchParams.searchTerms
                .toString(), false);
        OpenSearchParameter assignedToParameter = new OpenSearchParameter();
        assignedToParameter.setMandatory(false);
        assignedToParameter.setParameterKey(ASSIGNED_TO);
        assignedToParameter.setParameter(URN_ASSIGNED_TO);


        // create Search URL & populate search parameters for browsers
        OpenSearchUrl openSearchUrlForBrowsers = new OpenSearchUrl();
        openSearchUrlForBrowsers.addOpenSearchParameter(ftsParameter);
        openSearchUrlForBrowsers.setType(MediaType.TEXT_HTML);


        // create Search URL & populate search parameters
        OpenSearchUrl openSearchUrl = new OpenSearchUrl();
        openSearchUrl.addOpenSearchParameter(severityParameter);
        openSearchUrl.addOpenSearchParameter(ftsParameter);
        openSearchUrl.addOpenSearchParameter(assignedToParameter);
        openSearchUrl.setType(MediaType.TEXT_HTML);


        // create open search base uri
        StringBuilder openSearchUrlBuilder = new StringBuilder(baseUri);
        if (baseUri.endsWith("/") && URL.startsWith("/")) {
            openSearchUrlBuilder.append(URL.substring(1));
        } else {
            openSearchUrlBuilder.append(URL);
        }
        openSearchUrl.setBaseUri(openSearchUrlBuilder.toString());
        openSearchUrlForBrowsers.setBaseUri(openSearchUrlBuilder.toString());


        // add URLs to OpenSearch
        openSearchDescriptor.addUrl(openSearchUrlForBrowsers);
        openSearchDescriptor.addUrl(openSearchUrl);


        // add OpenSearch Query element
        OpenSearchQuery openSearchQuery = new OpenSearchQuery();
        openSearchQuery.setCount(new BigInteger("10"));
        openSearchQuery.setInputEncoding(ENCODING);
        openSearchQuery.setLanguage(LANG);
        openSearchQuery.setOutputEncoding(ENCODING);
        openSearchQuery.setRole(OpenSearchQuery.QueryRole.example.toString());
        openSearchQuery.setSearchTerms(SEARCH_TERM);
        openSearchQuery.setStartIndex(new BigInteger(START_INDEX));
        openSearchQuery.setStartPage(new BigInteger(START_PAGE));
        openSearchQuery.setTitle(TITLE);
        openSearchQuery.setTotalResults(new BigInteger(TOTAL_RESULT));
        openSearchDescriptor.addQuery(openSearchQuery);


        // add OpenSearch Images
        OpenSearchImage openSearchImage;
        openSearchImage =
            OpenSearchUtils.createOpenSearchImage(MediaTypeUtils.IMAGE_JPEG, openSearchUrlBuilder
                .toString() + "splash.jpg");
        openSearchDescriptor.addNewImage(openSearchImage);
        return openSearchDescriptor;
    }

View Full Code Here

TOP

Related Classes of org.apache.wink.common.model.opensearch.OpenSearchDescription

org.apache.wink.common.internal.providers.entity.OpenSearchProviderTest

org.apache.wink.common.model.JAXBNamespacePrefixMapper

org.apache.wink.example.qadefect.resources.DefectsResource

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.