View Javadoc

1   package ch.odi.justblog.api;
2   
3   import java.net.URL;
4   
5   /***
6    * 
7    *
8    * @author oglueck
9    */
10  public interface BlogApi {
11      /*** 
12       * Gets the "official" name of this Blog API.
13       * Should be the string used in RSD.
14       * 
15       * @return
16       */
17      String getRsdName();
18      
19      /***
20       * Gets the human readable name of this Blog API.
21       * @return
22       */
23      String getName();
24      
25      /***
26       * Tries to open the blog identified by <code>id</code> at the endpoint pointed 
27       * to by <code>apiurl</code>. Implementing classes should avoid to authenticate
28       * against the blog at this time. 
29       * 
30       * @param apiurl the API endpoint
31       * @param id the Blog ID
32       * @return Returns a Blog implementation.
33       */
34      Blog getBlog(URL apiurl, String id);
35  }