diff --git a/Flickr4Java/.gitignore b/Flickr4Java/.gitignore index 71df0227..d4c1a55c 100644 --- a/Flickr4Java/.gitignore +++ b/Flickr4Java/.gitignore @@ -11,3 +11,4 @@ Flickr4Java.iws .project .settings/ bin/ +**rebel.xml \ No newline at end of file diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/JSONResponse.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/JSONResponse.java new file mode 100644 index 00000000..fb28146d --- /dev/null +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/JSONResponse.java @@ -0,0 +1,13 @@ +package com.flickr4java.flickr; + +/** + * An interface for a response object which carries json + */ +public interface JSONResponse { + + /** + * Returns json as String + */ + StringBuilder getBody(); + +} diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/REST.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/REST.java index 256fdf23..97793017 100644 --- a/Flickr4Java/src/main/java/com/flickr4java/flickr/REST.java +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/REST.java @@ -4,11 +4,11 @@ package com.flickr4java.flickr; import com.flickr4java.flickr.auth.Auth; +import com.flickr4java.flickr.json.JSONResponseImpl; import com.flickr4java.flickr.util.Base64; import com.flickr4java.flickr.util.DebugInputStream; import com.flickr4java.flickr.util.IOUtilities; import com.flickr4java.flickr.util.UrlUtilities; - import org.apache.log4j.Logger; import org.scribe.builder.ServiceBuilder; @@ -37,7 +37,7 @@ /** * Transport implementation using the REST interface. - * + * * @author Anthony Eden * @version $Id: REST.java,v 1.26 2009/07/01 22:07:08 x-mago Exp $ */ @@ -82,7 +82,7 @@ public REST() { /** * Construct a new REST transport instance using the specified host endpoint. - * + * * @param host * The host endpoint */ @@ -93,7 +93,7 @@ public REST(String host) { /** * Construct a new REST transport instance using the specified host and port endpoint. - * + * * @param host * The host endpoint * @param port @@ -107,7 +107,7 @@ public REST(String host, int port) { /** * Set a proxy for REST-requests. - * + * * @param proxyHost * @param proxyPort */ @@ -119,7 +119,7 @@ public void setProxy(String proxyHost, int proxyPort) { /** * Set a proxy with authentication for REST-requests. - * + * * @param proxyHost * @param proxyPort * @param username @@ -134,7 +134,7 @@ public void setProxy(String proxyHost, int proxyPort, String username, String pa /** * Invoke an HTTP GET request on a remote host. You must close the InputStream after you are done with. - * + * * @param path * The request path * @param parameters @@ -144,6 +144,81 @@ public void setProxy(String proxyHost, int proxyPort, String username, String pa @Override public com.flickr4java.flickr.Response get(String path, Map parameters, String apiKey, String sharedSecret) { +// OAuthRequest request = new OAuthRequest(Verb.GET, getScheme() + "://" + getHost() + path); +// for (Map.Entry entry : parameters.entrySet()) { +// request.addQuerystringParameter(entry.getKey(), String.valueOf(entry.getValue())); +// } +// +// if (proxyAuth) { +// request.addHeader("Proxy-Authorization", "Basic " + getProxyCredentials()); +// } +// +// RequestContext requestContext = RequestContext.getRequestContext(); +// Auth auth = requestContext.getAuth(); +// if (auth != null) { +// Token requestToken = new Token(auth.getToken(), auth.getTokenSecret()); +// OAuthService service = createOAuthService(parameters, apiKey, sharedSecret); +// service.signRequest(requestToken, request); +// } else { +// // For calls that do not require authorization e.g. flickr.people.findByUsername which could be the +// // first call if the user did not supply the user-id (i.e. nsid). +// if (!parameters.containsKey(Flickr.API_KEY)) { +// request.addQuerystringParameter(Flickr.API_KEY, apiKey); +// } +// } +// +// if (Flickr.debugRequest) { +// logger.debug("GET: " + request.getCompleteUrl()); +// } +// setTimeouts(request); +// org.scribe.model.Response scribeResponse = request.send(); + + org.scribe.model.Response scribeResponse = getScribeResponse(path, parameters, apiKey, sharedSecret, false, false); + + try { + + com.flickr4java.flickr.Response response = null; + synchronized (mutex) { + String strXml = scribeResponse.getBody(); + if (Flickr.debugStream) { + logger.debug(strXml); + } + if (strXml.startsWith("oauth_problem=")) { + throw new FlickrRuntimeException(strXml); + } + Document document = builder.parse(new InputSource(new StringReader(strXml))); + response = (com.flickr4java.flickr.Response) responseClass.newInstance(); + response.parse(document); + } + return response; + } catch (IllegalAccessException e) { + throw new FlickrRuntimeException(e); + } catch (InstantiationException e) { + throw new FlickrRuntimeException(e); + } catch (SAXException e) { + throw new FlickrRuntimeException(e); + } catch (IOException e) { + throw new FlickrRuntimeException(e); + } + } + + + @Override + public JSONResponse getJson(String path, Map parameters, String apiKey, String sharedSecret, boolean noJsonCallback) throws FlickrException{ + JSONResponse json = null; + parameters.put("format","json"); + if(noJsonCallback){ + parameters.put("nojsoncallback", "1"); + } + + org.scribe.model.Response response = getScribeResponse(path,parameters,apiKey,sharedSecret,true, true); + synchronized (mutex){ + json = new JSONResponseImpl(response); + } + return json; + } + + private org.scribe.model.Response getScribeResponse(String path, Map parameters, String apiKey, String sharedSecret, boolean isJson, boolean noJsonCallback){ OAuthRequest request = new OAuthRequest(Verb.GET, getScheme() + "://" + getHost() + path); for (Map.Entry entry : parameters.entrySet()) { request.addQuerystringParameter(entry.getKey(), String.valueOf(entry.getValue())); @@ -172,39 +247,16 @@ public com.flickr4java.flickr.Response get(String path, Map para } setTimeouts(request); org.scribe.model.Response scribeResponse = request.send(); + return scribeResponse; + } - try { - com.flickr4java.flickr.Response response = null; - synchronized (mutex) { - String strXml = scribeResponse.getBody(); - if (Flickr.debugStream) { - logger.debug(strXml); - } - if (strXml.startsWith("oauth_problem=")) { - throw new FlickrRuntimeException(strXml); - } - Document document = builder.parse(new InputSource(new StringReader(strXml))); - response = (com.flickr4java.flickr.Response) responseClass.newInstance(); - response.parse(document); - } - return response; - } catch (IllegalAccessException e) { - throw new FlickrRuntimeException(e); - } catch (InstantiationException e) { - throw new FlickrRuntimeException(e); - } catch (SAXException e) { - throw new FlickrRuntimeException(e); - } catch (IOException e) { - throw new FlickrRuntimeException(e); - } - } /** * Invoke a non OAuth HTTP GET request on a remote host. - * + * * This is only used for the Flickr OAuth methods checkToken and getAccessToken. - * + * * @param path * The request path * @param parameters @@ -255,7 +307,7 @@ public Response getNonOAuth(String path, Map parameters) { /** * Invoke an HTTP POST request on a remote host. - * + * * @param path * The request path * @param parameters @@ -324,7 +376,7 @@ public com.flickr4java.flickr.Response post(String path, Map par } /** - * + * * @param parameters * @param sharedSecret * @return @@ -339,7 +391,7 @@ private OAuthService createOAuthService(Map parameters, String a } /** - * + * * @param parameters * @param request */ @@ -350,7 +402,7 @@ private void buildNormalPostRequest(Map parameters, OAuthRequest } /** - * + * * @param parameters * @param request */ @@ -365,7 +417,7 @@ private void buildMultipartRequest(Map parameters, OAuthRequest } /** - * + * * @return */ private String getMultipartBoundary() { @@ -378,7 +430,7 @@ public boolean isProxyAuth() { /** * Generates Base64-encoded credentials from locally stored username and password. - * + * * @return credentials */ public String getProxyCredentials() { @@ -389,19 +441,19 @@ private byte[] buildMultipartBody(Map parameters, String boundar ByteArrayOutputStream buffer = new ByteArrayOutputStream(); try { - String filename = (String) parameters.get("filename"); - if(filename == null) - filename = "image.jpg"; - - String fileMimeType = (String) parameters.get("filemimetype"); - if(fileMimeType == null) - fileMimeType = "image/jpeg"; - + String filename = (String) parameters.get("filename"); + if(filename == null) + filename = "image.jpg"; + + String fileMimeType = (String) parameters.get("filemimetype"); + if(fileMimeType == null) + fileMimeType = "image/jpeg"; + buffer.write(("--" + boundary + "\r\n").getBytes(CHARSET_NAME)); for (Entry entry : parameters.entrySet()) { String key = entry.getKey(); if(!key.equals("filename") && !key.equals("filemimetype")) - writeParam(key, entry.getValue(), buffer, boundary, filename, fileMimeType); + writeParam(key, entry.getValue(), buffer, boundary, filename, fileMimeType); } } catch (IOException e) { throw new FlickrRuntimeException(e); diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/Transport.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/Transport.java index 5e818cc9..5e3d01ac 100644 --- a/Flickr4Java/src/main/java/com/flickr4java/flickr/Transport.java +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/Transport.java @@ -8,7 +8,7 @@ /** * The abstract Transport class provides a common interface for transporting requests to the Flickr servers. Flickr offers several transport methods including * REST, SOAP and XML-RPC. Flickr4Java currently implements the REST transport and work is being done to include the SOAP transport. - * + * * @author Matt Ray * @author Anthony Eden */ @@ -26,7 +26,7 @@ public abstract class Transport { public static final String UPLOAD_API_HOST = "up.flickr.com"; protected static final String DEFAULT_SCHEME = "https"; - + private String transportType; protected Class responseClass; @@ -36,7 +36,7 @@ public abstract class Transport { private String host; private int port = 443; - + private String scheme; public String getHost() { @@ -81,7 +81,7 @@ public void setScheme(String scheme) { /** * Invoke an HTTP GET request on a remote host. You must close the InputStream after you are done with. - * + * * @param path * The request path * @param parameters @@ -93,9 +93,28 @@ public void setScheme(String scheme) { */ public abstract Response get(String path, Map parameters, String apiKey, String sharedSecret) throws FlickrException; + /** + * Invoke an HTTP GET request on a remote host. You must close the InputStream after you are done with. + * While #get request for XML which is further processed to marshalize flickr-objects, + * this method makes sure the response contaisn json which could be passed to a client (JavaScript available). + * + * @param path + * The request path + * @param parameters + * The parameters (collection of Parameter objects) + * @param apiKey + * @param sharedSecret + * @return The Response + * @throws FlickrException + */ + public abstract JSONResponse getJson(String path, Map parameters, String apiKey, String sharedSecret,boolean noJsonCallback) throws FlickrException; + + + + /** * Invoke an HTTP POST request on a remote host. - * + * * @param path * The request path * @param parameters @@ -109,7 +128,7 @@ public void setScheme(String scheme) { /** * Invoke an HTTP POST request on a remote host. - * + * * @param path * The request path * @param parameters @@ -126,9 +145,9 @@ public Response post(String path, Map parameters, String apiKey, /** * Invoke a non OAuth HTTP GET request on a remote host. - * + * * This is only used for the Flickr OAuth methods checkToken and getAccessToken. - * + * * @param path * The request path * @param parameters diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/json/JSONResponseImpl.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/json/JSONResponseImpl.java new file mode 100644 index 00000000..80a2c15a --- /dev/null +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/json/JSONResponseImpl.java @@ -0,0 +1,35 @@ +package com.flickr4java.flickr.json; + +import org.apache.log4j.Logger; +import org.scribe.model.Response; + +import com.flickr4java.flickr.JSONResponse; +import com.flickr4java.flickr.util.StringUtilities; + +/** + * + */ +public class JSONResponseImpl implements JSONResponse { + + private static final Logger logger = Logger.getLogger(JSONResponseImpl.class); + + + private Response scribeResponse; + private StringBuilder body; + + public JSONResponseImpl(Response scribeResponse){ + this.scribeResponse = scribeResponse; + if(StringUtilities.isNotBlank(scribeResponse.getBody())){ + body = new StringBuilder(scribeResponse.getBody()); + }else{ + body = new StringBuilder(""); + } + } + + @Override + public StringBuilder getBody() { + return body; + } + + +} diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/photos/PhotosInterface.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/photos/PhotosInterface.java index 7155ac81..d08a7712 100644 --- a/Flickr4Java/src/main/java/com/flickr4java/flickr/photos/PhotosInterface.java +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/photos/PhotosInterface.java @@ -3,22 +3,6 @@ */ package com.flickr4java.flickr.photos; -import com.flickr4java.flickr.FlickrException; -import com.flickr4java.flickr.REST; -import com.flickr4java.flickr.RequestContext; -import com.flickr4java.flickr.Response; -import com.flickr4java.flickr.Transport; -import com.flickr4java.flickr.people.User; -import com.flickr4java.flickr.photos.geo.GeoInterface; -import com.flickr4java.flickr.util.IOUtilities; -import com.flickr4java.flickr.util.StringUtilities; -import com.flickr4java.flickr.util.XMLUtilities; - -import org.w3c.dom.Element; -import org.w3c.dom.NodeList; - -import javax.imageio.ImageIO; - import java.awt.image.BufferedImage; import java.io.IOException; import java.io.InputStream; @@ -35,9 +19,26 @@ import java.util.Map; import java.util.Set; +import javax.imageio.ImageIO; + +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; + +import com.flickr4java.flickr.FlickrException; +import com.flickr4java.flickr.JSONResponse; +import com.flickr4java.flickr.REST; +import com.flickr4java.flickr.RequestContext; +import com.flickr4java.flickr.Response; +import com.flickr4java.flickr.Transport; +import com.flickr4java.flickr.people.User; +import com.flickr4java.flickr.photos.geo.GeoInterface; +import com.flickr4java.flickr.util.IOUtilities; +import com.flickr4java.flickr.util.StringUtilities; +import com.flickr4java.flickr.util.XMLUtilities; + /** * Interface for working with Flickr Photos. - * + * * @author Anthony Eden * @version $Id: PhotosInterface.java,v 1.51 2010/07/20 20:11:16 x-mago Exp $ */ @@ -120,7 +121,7 @@ public PhotosInterface(String apiKey, String sharedSecret, Transport transport) /** * Get the geo interface. - * + * * @return Access class to the flickr.photos.geo methods. */ public synchronized GeoInterface getGeoInterface() { @@ -132,9 +133,9 @@ public synchronized GeoInterface getGeoInterface() { /** * Add tags to a photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param tags @@ -156,9 +157,9 @@ public void addTags(String photoId, String[] tags) throws FlickrException { /** * Delete a photo from flickr. - * + * * This method requires authentication with 'delete' permission. - * + * * @param photoId * @throws FlickrException */ @@ -179,19 +180,19 @@ public void delete(String photoId) throws FlickrException { /** * Returns all visble sets and pools the photo belongs to. - * + * * This method does not require authentication. - * + * * @param photoId * The photo to return information for. * @return a list of {@link PhotoContext} objects * @throws FlickrException */ public PhotoAllContext getAllContexts(String photoId) throws FlickrException { - PhotoSetList setList = new PhotoSetList(); - PoolList poolList = new PoolList(); - PhotoAllContext allContext = new PhotoAllContext(); - + PhotoSetList setList = new PhotoSetList(); + PoolList poolList = new PoolList(); + PhotoAllContext allContext = new PhotoAllContext(); + Map parameters = new HashMap(); parameters.put("method", METHOD_GET_ALL_CONTEXTS); @@ -203,44 +204,44 @@ public PhotoAllContext getAllContexts(String photoId) throws FlickrException { } Collection photosElement = response.getPayloadCollection(); - for (Element setElement : photosElement) { - if(setElement.getTagName().equals("set")){ - PhotoSet pset = new PhotoSet(); - pset.setTitle(setElement.getAttribute("title")); - pset.setSecret(setElement.getAttribute("secret")); - pset.setId(setElement.getAttribute("id")); - pset.setFarm(setElement.getAttribute("farm")); - pset.setPrimary(setElement.getAttribute("primary")); - pset.setServer(setElement.getAttribute("server")); - pset.setViewCount(Integer.parseInt(setElement.getAttribute("view_count"))); - pset.setCommentCount(Integer.parseInt(setElement.getAttribute("comment_count"))); - pset.setCountPhoto(Integer.parseInt(setElement.getAttribute("count_photo"))); - pset.setCountVideo(Integer.parseInt(setElement.getAttribute("count_video"))); - setList.add(pset); - allContext.setPhotoSetList(setList); - }else if(setElement.getTagName().equals("pool")){ - Pool pool = new Pool(); - pool.setTitle(setElement.getAttribute("title")); - pool.setId(setElement.getAttribute("id")); - pool.setUrl(setElement.getAttribute("url")); - pool.setIconServer(setElement.getAttribute("iconserver")); - pool.setIconFarm(setElement.getAttribute("iconfarm")); - pool.setMemberCount(Integer.parseInt(setElement.getAttribute("members"))); - pool.setPoolCount(Integer.parseInt(setElement.getAttribute("pool_count"))); - poolList.add(pool); - allContext.setPoolList(poolList); - } - } - + for (Element setElement : photosElement) { + if(setElement.getTagName().equals("set")){ + PhotoSet pset = new PhotoSet(); + pset.setTitle(setElement.getAttribute("title")); + pset.setSecret(setElement.getAttribute("secret")); + pset.setId(setElement.getAttribute("id")); + pset.setFarm(setElement.getAttribute("farm")); + pset.setPrimary(setElement.getAttribute("primary")); + pset.setServer(setElement.getAttribute("server")); + pset.setViewCount(Integer.parseInt(setElement.getAttribute("view_count"))); + pset.setCommentCount(Integer.parseInt(setElement.getAttribute("comment_count"))); + pset.setCountPhoto(Integer.parseInt(setElement.getAttribute("count_photo"))); + pset.setCountVideo(Integer.parseInt(setElement.getAttribute("count_video"))); + setList.add(pset); + allContext.setPhotoSetList(setList); + }else if(setElement.getTagName().equals("pool")){ + Pool pool = new Pool(); + pool.setTitle(setElement.getAttribute("title")); + pool.setId(setElement.getAttribute("id")); + pool.setUrl(setElement.getAttribute("url")); + pool.setIconServer(setElement.getAttribute("iconserver")); + pool.setIconFarm(setElement.getAttribute("iconfarm")); + pool.setMemberCount(Integer.parseInt(setElement.getAttribute("members"))); + pool.setPoolCount(Integer.parseInt(setElement.getAttribute("pool_count"))); + poolList.add(pool); + allContext.setPoolList(poolList); + } + } + return allContext; } /** * Get photos from the user's contacts. - * + * * This method requires authentication with 'read' permission. - * + * * @param count * The number of photos to return * @param justFriends @@ -290,9 +291,9 @@ public PhotoList getContactsPhotos(int count, boolean justFriends, boolea /** * Get public photos from the user's contacts. - * + * * This method does not require authentication. - * + * * @see com.flickr4java.flickr.photos.Extras * @param userId * The user ID @@ -365,9 +366,9 @@ public PhotoList getContactsPublicPhotos(String userId, Set extra /** * Get the context for the specified photo. - * + * * This method does not require authentication. - * + * * @param photoId * The photo ID * @return The PhotoContext @@ -410,9 +411,9 @@ public PhotoContext getContext(String photoId) throws FlickrException { /** * Gets a collection of photo counts for the given date ranges for the calling user. - * + * * This method requires authentication with 'read' permission. - * + * * @param dates * An array of dates, denoting the periods to return counts for. They should be specified smallest first. * @param takenDates @@ -464,11 +465,11 @@ public Collection getCounts(Date[] dates, Date[] takenDates) throws /** * Get the Exif data for the photo. - * + * * The calling user must have permission to view the photo. - * + * * This method does not require authentication. - * + * * @param photoId * The photo ID * @param secret @@ -508,9 +509,9 @@ public Collection getExif(String photoId, String secret) throws FlickrExce /** * Returns the list of people who have favorited a given photo. - * + * * This method does not require authentication. - * + * * @param photoId * @param perPage * @param page @@ -552,11 +553,11 @@ public Collection getFavorites(String photoId, int perPage, int page) thro /** * Get all info for the specified photo. - * + * * The calling user must have permission to view the photo. - * + * * This method does not require authentication. - * + * * @param photoId * The photo Id * @param secret @@ -582,11 +583,30 @@ public Photo getInfo(String photoId, String secret) throws FlickrException { return PhotoUtils.createPhoto(photoElement); } + /** + * Returns json reponse as {@link StringBuilder} from flickr api
+ * Feasible when flickr4java is a flickr-api-proxy go get json + * + * @throws FlickrException + */ + public StringBuilder getInfoAsJson(String photoId, String secret, boolean noJsonCallback) throws FlickrException { + Map parameters = new HashMap(); + parameters.put("method", METHOD_GET_INFO); + + parameters.put("photo_id", photoId); + if (secret != null) { + parameters.put("secret", secret); + } + JSONResponse jsonResponse = transport.getJson(transport.getPath(), parameters, apiKey, sharedSecret, noJsonCallback); + + return jsonResponse.getBody(); + } + /** * Return a collection of Photo objects not in part of any sets. - * + * * This method requires authentication with 'read' permission. - * + * * @param perPage * The per page * @param page @@ -634,9 +654,9 @@ public PhotoList getNotInSet(int perPage, int page) throws FlickrExceptio /** * Get the permission information for the specified photo. - * + * * This method requires authentication with 'read' permission. - * + * * @param photoId * The photo id * @return The Permissions object @@ -665,9 +685,9 @@ public Permissions getPerms(String photoId) throws FlickrException { /** * Get a collection of recent photos. - * + * * This method does not require authentication. - * + * * @see com.flickr4java.flickr.photos.Extras * @param extras * Set of extra-fields @@ -703,11 +723,11 @@ public PhotoList getRecent(Set extras, int perPage, int page) thr /** * Get the available sizes of a Photo. - * + * * The calling user must have permission to view the photo. - * + * * This method uses no authentication. - * + * * @param photoId * The photo ID * @return A collection of {@link Size} @@ -717,13 +737,16 @@ public Collection getSizes(String photoId) throws FlickrException { return getSizes(photoId, false); } + + + /** * Get the available sizes of a Photo. - * + * * The boolean toggle allows to (api-)sign the call. - * + * * This way the calling user can retrieve sizes for his own private photos. - * + * * @param photoId * The photo ID * @param sign @@ -732,7 +755,7 @@ public Collection getSizes(String photoId) throws FlickrException { * @throws FlickrException */ public Collection getSizes(String photoId, boolean sign) throws FlickrException { - SizeList sizes = new SizeList(); + SizeList sizes = new SizeList(); Map parameters = new HashMap(); parameters.put("method", METHOD_GET_SIZES); @@ -762,11 +785,20 @@ public Collection getSizes(String photoId, boolean sign) throws FlickrExce return sizes; } + public StringBuilder getSizesAsJson(String photoId, boolean noJsonCallback) throws FlickrException { + Map parameters = new HashMap(); + parameters.put("method", METHOD_GET_SIZES); + parameters.put("photo_id", photoId); + + JSONResponse response = transport.getJson(transport.getPath(), parameters, apiKey, sharedSecret, noJsonCallback); + return response.getBody(); + } + /** * Get the collection of untagged photos. - * + * * This method requires authentication with 'read' permission. - * + * * @param perPage * @param page * @return A Collection of Photos @@ -794,9 +826,9 @@ public PhotoList getUntagged(int perPage, int page) throws FlickrExceptio /** * Returns a list of your geo-tagged photos. - * + * * This method requires authentication with 'read' permission. - * + * * @param minUploadDate * Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. Set to null to not specify a date. * @param maxUploadDate @@ -815,7 +847,7 @@ public PhotoList getUntagged(int perPage, int page) throws FlickrExceptio *
  • 5 completely private photos
    • * * Set to 0 to not specify a privacy Filter. - * + * * @see com.flickr4java.flickr.photos.Extras * @param sort * The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, @@ -831,7 +863,7 @@ public PhotoList getUntagged(int perPage, int page) throws FlickrExceptio * @throws FlickrException */ public PhotoList getWithGeoData(Date minUploadDate, Date maxUploadDate, Date minTakenDate, Date maxTakenDate, int privacyFilter, String sort, - Set extras, int perPage, int page) throws FlickrException { + Set extras, int perPage, int page) throws FlickrException { Map parameters = new HashMap(); parameters.put("method", METHOD_GET_WITH_GEO_DATA); @@ -874,9 +906,9 @@ public PhotoList getWithGeoData(Date minUploadDate, Date maxUploadDate, D /** * Returns a list of your photos which haven't been geo-tagged. - * + * * This method requires authentication with 'read' permission. - * + * * @param minUploadDate * Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. Set to null to not specify a date. * @param maxUploadDate @@ -895,7 +927,7 @@ public PhotoList getWithGeoData(Date minUploadDate, Date maxUploadDate, D *
  • 5 completely private photos
    • * * Set to 0 to not specify a privacy Filter. - * + * * @see com.flickr4java.flickr.photos.Extras * @param sort * The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, @@ -911,7 +943,7 @@ public PhotoList getWithGeoData(Date minUploadDate, Date maxUploadDate, D * @throws FlickrException */ public PhotoList getWithoutGeoData(Date minUploadDate, Date maxUploadDate, Date minTakenDate, Date maxTakenDate, int privacyFilter, String sort, - Set extras, int perPage, int page) throws FlickrException { + Set extras, int perPage, int page) throws FlickrException { Map parameters = new HashMap(); parameters.put("method", METHOD_GET_WITHOUT_GEO_DATA); @@ -955,9 +987,9 @@ public PhotoList getWithoutGeoData(Date minUploadDate, Date maxUploadDate /** * Return a list of your photos that have been recently created or which have been recently modified. Recently modified may mean that the photo's metadata * (title, description, tags) may have been changed or a comment has been added (or just modified somehow :-) - * + * * This method requires authentication with 'read' permission. - * + * * @see com.flickr4java.flickr.photos.Extras * @param minDate * Date indicating the date from which modifications should be compared. Must be given. @@ -998,9 +1030,9 @@ public PhotoList recentlyUpdated(Date minDate, Set extras, int pe /** * Remove a tag from a photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param tagId * The tag ID * @throws FlickrException @@ -1019,7 +1051,7 @@ public void removeTag(String tagId) throws FlickrException { /** * Search for photos which match the given search parameters. - * + * * @param params * The search parameters * @param perPage @@ -1064,7 +1096,7 @@ public PhotoList search(SearchParameters params, int perPage, int page) t /** * Search for interesting photos using the Flickr Interestingness algorithm. - * + * * @param params * Any search parameters * @param perPage @@ -1123,9 +1155,9 @@ public PhotoList searchInterestingness(SearchParameters params, int perPa /** * Set the content type of a photo. - * + * * This method requires authentication with 'write' permission. - * + * * @see com.flickr4java.flickr.Flickr#CONTENTTYPE_PHOTO * @see com.flickr4java.flickr.Flickr#CONTENTTYPE_SCREENSHOT * @see com.flickr4java.flickr.Flickr#CONTENTTYPE_OTHER @@ -1150,9 +1182,9 @@ public void setContentType(String photoId, String contentType) throws FlickrExce /** * Set the dates for the specified photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param datePosted @@ -1189,9 +1221,9 @@ public void setDates(String photoId, Date datePosted, Date dateTaken, String dat /** * Set the meta data for the photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param title @@ -1216,9 +1248,9 @@ public void setMeta(String photoId, String title, String description) throws Fli /** * Set the permissions for the photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param permissions @@ -1245,9 +1277,9 @@ public void setPerms(String photoId, Permissions permissions) throws FlickrExcep /** * Set the safety level (adultness) of a photo. *

    - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param safetyLevel @@ -1281,9 +1313,9 @@ public void setSafetyLevel(String photoId, String safetyLevel, Boolean hidden) t /** * Set the tags for a photo. - * + * * This method requires authentication with 'write' permission. - * + * * @param photoId * The photo ID * @param tags @@ -1305,7 +1337,7 @@ public void setTags(String photoId, String[] tags) throws FlickrException { /** * Get the photo for the specified ID. Currently maps to the getInfo() method. - * + * * @param id * The ID * @return The Photo @@ -1316,7 +1348,7 @@ public Photo getPhoto(String id) throws FlickrException { /** * Get the photo for the specified ID with the given secret. Currently maps to the getInfo() method. - * + * * @param id * The ID * @param secret @@ -1331,9 +1363,9 @@ public Photo getPhoto(String id, String secret) throws FlickrException { * Request an image from the Flickr-servers.
    * Callers must close the stream upon completion. *

    - * + * * At {@link Size} you can find constants for the available sizes. - * + * * @param photo * A photo-object * @param size @@ -1369,18 +1401,18 @@ public InputStream getImageAsStream(Photo photo, int size) throws FlickrExceptio } else if (size == Size.MEDIUM_800) { urlStr = photo.getMedium800Url(); } else if (size == Size.VIDEO_ORIGINAL) { - urlStr = photo.getVideoOriginalUrl(); + urlStr = photo.getVideoOriginalUrl(); } else if (size == Size.VIDEO_PLAYER) { - urlStr = photo.getVideoPlayerUrl(); + urlStr = photo.getVideoPlayerUrl(); } else if (size == Size.SITE_MP4) { - urlStr = photo.getSiteMP4Url(); - } - else if(size == Size.MOBILE_MP4) { - urlStr = photo.getMobileMp4Url(); - } - else if(size == Size.HD_MP4) { - urlStr = photo.getHdMp4Url(); - } else { + urlStr = photo.getSiteMP4Url(); + } + else if(size == Size.MOBILE_MP4) { + urlStr = photo.getMobileMp4Url(); + } + else if(size == Size.HD_MP4) { + urlStr = photo.getHdMp4Url(); + } else { throw new FlickrException("0", "Unknown Photo-size"); } URL url = new URL(urlStr); @@ -1400,9 +1432,9 @@ else if(size == Size.HD_MP4) { /** * Request an image from the Flickr-servers. *

    - * + * * At {@link Size} you can find constants for the available sizes. - * + * * @param photo * A photo-object * @param size @@ -1420,7 +1452,7 @@ public BufferedImage getImage(Photo photo, int size) throws FlickrException { /** * Download of an image by URL. - * + * * @param urlStr * The URL of a Photo * @return BufferedImage The The Image diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/util/StringUtilities.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/util/StringUtilities.java index 2abb1417..75692db7 100644 --- a/Flickr4Java/src/main/java/com/flickr4java/flickr/util/StringUtilities.java +++ b/Flickr4Java/src/main/java/com/flickr4java/flickr/util/StringUtilities.java @@ -10,7 +10,10 @@ /** * String utility methods. - * + * + * + * // TODO: what about adding org.apache.commons.lang3 ? + * * @author Anthony Eden * @version $Id: StringUtilities.java,v 1.5 2009/07/23 20:41:03 x-mago Exp $ */ @@ -21,9 +24,18 @@ private StringUtilities() { } + public static boolean isNotBlank(String string){ + return string != null && string.length()>0; + } + + public static boolean isBlank(String string){ + return string == null && string.length()==0; + } + + /** * Join the array of Strings using the specified delimiter. - * + * * @param s * The String array * @param delimiter @@ -40,7 +52,7 @@ public static String join(String[] s, String delimiter, boolean doQuote) { /** * Join the Collection of Strings using the specified delimter and optionally quoting each - * + * * @param s * The String collection * @param delimiter @@ -67,7 +79,7 @@ public static String join(Collection s, String delimiter, boolean doQuot /** * Join the Collection of Strings using the specified delimiter. - * + * * @param s * The String collection * @param delimiter